yuntongxun_aiorest.rest module¶
REST API
参考: http://docs.yuntongxun.com/index.php/Rest%E4%BB%8B%E7%BB%8D
-
yuntongxun_aiorest.rest.
invoke
(base_url, auth_type, account_sid, auth_token, func, func_des, params=None, headers=None, data=None, timeout=15)¶ 进行一次 REST 调用
参数: - base_url (str) –
所有被引用的地址都有如下 Base URL:
- 沙盒地址,用于应用上线前进行业务测试: https://sandboxapp.cloopen.com:8883/2013-12-26
- 生产地址,用于应用上线后进行正式业务: https://app.cloopen.com:8883/2013-12-26
注意
为了确保数据隐私,云通讯平台的REST API是通过HTTPS方式请求。
- auth_type (str) –
验证级别, 必选 有:
- Accounts : 主帐号鉴权,云通讯平台会对请求中的主帐号和主帐号Token进行验证
- SubAccounts : 子帐号鉴权,云通讯平台会对请求中的子帐号和子帐号Token进行验证
- account_sid (str) – 主账户或者子账户Id。由32个英文字母和阿拉伯数字组成的主账户唯一标识符 必选
- auth_token (str) – 账户 TOKEN 必选
- func (str) – 描述业务功能,必选 。对于 IVR API 这参数必须是 ivr
- func_des (str) – 描述业务功能的具体操作 必选
- params (dict) – URL 参数
- headers (dict) – HTTP 请求头域键值对
- data –
POST 请求数据,它的数据类型可以是:
None
: 将是一个 GET 请求dict
: 采用 JSON 格式的调用xml.etree.ElementTree.ElementTree
: 采用 XML 格式的调用
- timeout (int) – HTTP 超时(秒)
返回类型: 返回: RestAPI 返回结果。XML结果中的标签被转化为了属性名,文本被转化为了属性值
- base_url (str) –
-
yuntongxun_aiorest.rest.
recursive_resp_xml_node
(node)¶