短信消息API---Python

简介


当您使用短信的API接口发送短信后，可以通过使用MNS的Queue模型来接收短信的回执消息，假如服务出现异常情况时(如网络问题)，导致消息回执未成功获取，还可以通过短信发送状态查询API接口进行一定的补偿(目前支持30天内发送记录的查询)。

消息的订阅

• 云通信的所有业务消息都用过MNS消息服务向外发送。用户每订阅一个类别的消息(比如上行短信消息SmsUp)，系统都会为用户分配一个独立的消息队列。
• 用户可以通过阿里云账号拿到一个临时的token用于获取队列中的消息。用户可以下载demo，编写简单的消息处理类即可完成消息处理的任务。
• 在页面上订阅消息，订阅完消息后，能拿到消息队列名称(queueName)。比如：Alicom-Queue-xxxxxx-SmsReport 。队列名字每个用户都不同。

消息类型


短信提供2种消息类型SmsReport(短信回执报告消息) 和 SmsUp(上行短信消息)

• 通过订阅SmsReport短信状态报告，可以获知每条短信的发送情况，了解短信是否达到终端用户的状态与相关信息
• 通过订阅SmsUp上行短信消息，可以获知终端用户回复短信的内容

短信回执消息SmsReport消息体格式

名称	类型	描述	示例	是否必须
phone_number	String	短信接收号码	13000000000	可选
success	Boolean	发送是否成功	true	必须
biz_id	String	发送回执ID	1234^345	必须
out_id	String	调用发送短信接口时传的outId	123456	可选
send_time	String	转发给运营商的时间	2017-06-01 10:00:00	必须
report_time	String	收到运营商回执的时间	2017-06-01 10:00:05	可选
err_code	String	错误码	UNKNOW	可选
err_msg	String	错误信息	未知异常	可选
sms_size	String	140字节算一条短信，短信长度超过140字节时会拆分成多条短信发送	1，2，3	可选

上行短信消息SmsUp

名称	类型	描述	示例	是否必须
phone_number	String	短信接收号码	13000000000	可选
content	String	短信内容	true	必须
send_time	String	时间	20150101120000	必须
dest_code	String	扩展码	123456	必须
sequence_id	String	消息序列ID	123456	必须

技术对接步骤



下载消息SDK


SDK工具包中一共包含了3个目录：
aliyun-python-sdk-core：阿里云api调用的核心代码库，python版本。
mns_python_sdk：阿里云mns产品消息订阅sdk代码库。
aliyunsdkdybaseapi：云通信业务（语音、流量、短信）基础接口代码，用于订阅消息时获取token以及账号信息。
确定本机已经安装了python，版本要求：2.6.5 或以上版本。
进入aliyun-python-sdk-core 目录执行：python setup.py install。
进入mns_python_sdk目录执行：python setup.py install。
运行demo示例。进入alicom-mns-receive-samples-python目录执行：python sample.py 。
SDK&DEMO[ 下载地址]

编写样例代码

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; margin-top: 0px; margin-right: 0px; margin-bottom: 0px !important; margin-left: 0px; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

1. #!/usr/bin/env python
2. # coding=utf8
3. import sys
4. from aliyunsdkcore.acs_exception.exceptions import ServerException
5. from aliyunsdkcore.client import AcsClient
6. from aliyunsdkdybaseapi.request.v20170525.QueryTokenForMnsQueueRequest import QueryTokenForMnsQueueRequest
8. import datetime
9. from mns.account import Account
10. from mns.queue import *
12. try:
13.     import json
14. except ImportError:
15.     import simplejson as json
17. """
18. 云通信基础能力业务回执消息消费示例，供参考。
19. Created on 2017-06-13
20. """
22. reload(sys)
23. sys.setdefaultencoding('utf8')
25. regionid = "cn-hangzhou"
27. # ACCESS_KEY_ID/ACCESS_KEY_SECRET 根据实际申请的账号信息进行替换
28. accesskeyid = "yourAccessKeyId"
29. accesskeysecret = "yourAccessKeySecret"
30. endpoint = "http://1943695596114318.mns.cn-hangzhou.aliyuncs.com"
32. # 短信回执报告：SmsReport，短息上行：SmsUp
33. msgtype = "SmsReport"
34. # 在云通信页面开通相应业务消息后，就能在页面上获得对应的queueName
35. qname = "Alicom-Queue-1093695199815616-SmsReport"
36. #初始化acs_client
37. acs_client = AcsClient(accesskeyid, accesskeysecret, regionid)
39. # 云通信业务token存在失效时间，需动态更新。
40. class Token():
41.     def __init__(self, token=None, tmp_access_id=None, tmp_access_key=None, expire_time=None):
42.         self.__token = token
43.         self.__tmp_access_id = tmp_access_id
44.         self.__tmp_access_key = tmp_access_key
45.         self.__expire_time = expire_time
47.     def get_token(self):
48.         return self.__token
50.     def set_token(self, token):
51.         self.__token = token
53.     def get_tmp_access_id(self):
54.         return self.__tmp_access_id
56.     def set_tmp_access_id(self, tmp_access_id):
57.         self.__tmp_access_id = tmp_access_id
59.     def get_tmp_access_key(self):
60.         return self.__tmp_access_key
62.     def set_tmp_access_key(self, tmp_access_key):
63.         self.__tmp_access_key = tmp_access_key
65.     def get_expire_time(self):
66.         return self.__expire_time
68.     def set_expire_time(self, expire_time):
69.         self.__expire_time = expire_time
71.     def is_refresh(self):
72.         # 失效时间与当前系统时间比较，提前2分钟刷新token
73.         now = datetime.datetime.now()
74.         expire = datetime.datetime.strptime(self.__expire_time, "%Y-%m-%d %H:%M:%S")
75.         # intval = (expire - now).seconds
76.         # print "token生效剩余时长（秒）：" + str(intval)
77.         if (expire - now).seconds < 120:
78.             return 1
79.         return 0
81.     def refresh(self):
82.         print "start refresh token..."
83.         request = QueryTokenForMnsQueueRequest()
84.         request.set_MessageType(msgtype)
85.         response = acs_client.do_action_with_exception(request)
86.         # print response
87.         if response is None:
88.             raise ServerException("GET_TOKEN_FAIL", "获取token时无响应")
90.         response_body = json.loads(response)
92.         if response_body.get("Code") != "OK":
93.             raise ServerException("GET_TOKEN_FAIL", "获取token失败")
95.         self.__tmp_access_key = response_body.get("MessageTokenDTO").get("AccessKeySecret")
96.         self.__tmp_access_id = response_body.get("MessageTokenDTO").get("AccessKeyId")
97.         self.__expire_time = response_body.get("MessageTokenDTO").get("ExpireTime")
98.         self.__token = response_body.get("MessageTokenDTO").get("SecurityToken")
100.         print "finsh refresh token..."
103. # 初始化 my_account, my_queue
104. token = Token()
105. token.refresh()
106. my_account = Account(endpoint, token.get_tmp_access_id(), token.get_tmp_access_key(), token.get_token())
107. my_queue = my_account.get_queue(qname)
108. # my_queue.set_encoding(False)
109. # 循环读取删除消息直到队列空
110. # receive message请求使用long polling方式，通过wait_seconds指定长轮询时间为3秒
112. ## long polling 解析:
113. ### 当队列中有消息时，请求立即返回；
114. ### 当队列中没有消息时，请求在MNS服务器端挂3秒钟，在这期间，有消息写入队列，请求会立即返回消息，3秒后，请求返回队列没有消息；
116. wait_seconds = 3
117. print "%sReceive And Delete Message From Queue%s\nQueueName:%s\nWaitSeconds:%s\n" % (
118.     10 * "=", 10 * "=", qname, wait_seconds)
119. while True:
120.     # 读取消息
121.     try:
122.         if token.is_refresh() == 1:
123.             # 刷新token
124.             token.refresh()
125.             my_account.mns_client.close_connection();
126.             my_account = Account(endpoint, token.get_tmp_access_id(), token.get_tmp_access_key(), token.get_token())
127.             my_queue = my_account.get_queue(qname)
128.             # my_queue.set_encoding(False)
129.         recv_msg = my_queue.receive_message(wait_seconds)
130.         print "Receive Message Succeed! ReceiptHandle:%s MessageBody:%s MessageID:%s" % (
131.             recv_msg.receipt_handle, recv_msg.message_body, recv_msg.message_id)
132.     except MNSExceptionBase, e:
133.         if e.type == "QueueNotExist":
134.             print "Queue not exist, please create queue before receive message."
135.             sys.exit(0)
136.         elif e.type == "MessageNotExist":
137.             print "Queue is empty! sleep 10s"
138.             time.sleep(10)
139.             continue
140.         print "Receive Message Fail! Exception:%s\n" % e
141.         continue
143.     # 删除消息
144.     try:
145.         my_queue.delete_message(recv_msg.receipt_handle)
146.         print "Delete Message Succeed!  ReceiptHandle:%s" % recv_msg.receipt_handle
147.     except MNSExceptionBase, e:
148.         print "Delete Message Fail! Exception:%s\n" % e