“接口说明”的版本间的差异
来自uucall
| 第1行： | 第1行： | ||
| − | * 介绍 | + | <br /> |
| + | *<big><big>'''介绍'''</big></big> | ||
云通讯平台REST 接口为开发者提供主账户信息查询、创建子账户、获取子账户、模板短信、双向回拨、外呼通知、语音验证码、IVR外呼、会议管理和座席管理等功能。 | 云通讯平台REST 接口为开发者提供主账户信息查询、创建子账户、获取子账户、模板短信、双向回拨、外呼通知、语音验证码、IVR外呼、会议管理和座席管理等功能。 | ||
| 第6行： | 第7行： | ||
由于API是基于REST原则上的，所以它很容易编写和测试应用程序。您可以使用浏览器访问URL，也可以使用几乎任何客户端在任何编程语言与REST API进行交互。 | 由于API是基于REST原则上的，所以它很容易编写和测试应用程序。您可以使用浏览器访问URL，也可以使用几乎任何客户端在任何编程语言与REST API进行交互。 | ||
| − | + | *<big><big>'''Base URL'''</big></big> | |
模板短信API引用的地址有Base URL。 | 模板短信API引用的地址有Base URL。 | ||
| 第16行： | 第17行： | ||
注意：为了确保数据隐私，云通讯平台的REST API是通过HTTPS方式请求。 | 注意：为了确保数据隐私，云通讯平台的REST API是通过HTTPS方式请求。 | ||
| − | + | *<big><big>'''统一请求包头'''</big></big> | |
URL格式：rest/{path} | URL格式：rest/{path} | ||
| 第33行： | 第34行： | ||
2.SigParameter参数需要大写，如不能写成sig=abcdefg而应该写成sig=ABCDEFG | 2.SigParameter参数需要大写，如不能写成sig=abcdefg而应该写成sig=ABCDEFG | ||
|} | |} | ||
| + | |||
| + | *<big><big>'''返回值说明'''</big></big> | ||
2016年3月29日 (二) 17:19的版本
- 介绍
云通讯平台REST 接口为开发者提供主账户信息查询、创建子账户、获取子账户、模板短信、双向回拨、外呼通知、语音验证码、IVR外呼、会议管理和座席管理等功能。
当您第一次使用云通讯平台REST API时，您需要在首页注册账号，我们会给您自动分配一个主账户及若干子账户，子账户可以让您轻松的管理客户信息以及控制客户使用情况。欲了解子账户更多信息，请参阅创建子账户。
由于API是基于REST原则上的，所以它很容易编写和测试应用程序。您可以使用浏览器访问URL，也可以使用几乎任何客户端在任何编程语言与REST API进行交互。
- Base URL
模板短信API引用的地址有Base URL。
沙盒环境的Base URL：https://sandboxapp.cloopen.com:8883
生产环境的Base URL：https://app.cloopen.com:8883
注意：为了确保数据隐私，云通讯平台的REST API是通过HTTPS方式请求。
- 统一请求包头
URL格式：rest/{path}
在URL格式中 {}内的内容表示为参数，非{}的内容固定不变。
属性说明：
| 属性 | 类型 | 约束 | 说明 |
|---|---|---|---|
| userName | String | 必选 | 接口使用者主帐号名称（合作客户登录主帐号） |
| SigParameter | String | 必选 | REST API 验证参数，生成规则如下
1.使用MD5加密（userName+":"+apikey+":"+timestamp）。时间戳是当前系统时间，格式"yyyyMMddHHmmss"。时间戳有效时间为24小时，如：20140416142030 2.SigParameter参数需要大写，如不能写成sig=abcdefg而应该写成sig=ABCDEFG |
- 返回值说明
