開發者賬戶使用使用指南
開放接口使用指南
平臺審核標準
平臺服務標準
Rest API接口介紹
取消通話接口
通話記錄查詢接口
錄音及下載接口
專線語音接口
專號通接口
專號通號碼申請接口
專號通號碼查詢接口
專號通號碼釋放接口
應用映射號碼查詢接口
語音通知下發接口
取消預約語音通知接口
語音通知記錄查詢接口
語音驗證碼接口
智能語音驗證接口
訂單小號綁定接口
訂單小號解綁接口
訂單小號查詢接口
訂單小號話單查詢接口
虛擬小號綁定接口
虛擬小號解綁接口
虛擬小號更新接口
虛擬小號查詢接口
虛擬小號在線呼叫接口
虛擬小號雙呼接口
虛擬小號開關機接口
虛擬小號開關機查詢接口
虛擬小號話單查詢接口
營銷電話在線呼叫接口
批量上傳號碼接口
語音回呼接口
手機專號通綁定接口
手機專號通解綁接口
手機專號通更新接口
手機專號通查詢接口
手機專號通雙呼接口
專線語音回調通知接口
專號通回調通知接口
語音通知狀態回調接口
語音驗證碼回調接口
智能語音驗證回調接口
訂單小號狀態回調接口
虛擬小號狀態回調
營銷電話狀態回調
AI智能語音回調接口
語音回呼回調接口
手機專號通回調接口
全局錯誤碼表
REST即表述性狀態傳遞(英文:Representational State Transfer,簡稱REST)是一套新興的WEB通訊協議,訪問方式和普通的HTTP類似,平臺接口分GET和POST兩種請求方式。
玖云平臺REST接口為第三方應用提供了簡單易用的API調用服務,第三方開發者可以快速、高效、低成本的集成玖云平臺API,輕松體驗其強大的通信能力。
玖云平臺的REST接口支持JSON及XML兩種請求格式,采用MD5加密算法,通過URL形式發送參數。
(1).accountSid:用戶注冊后,為每一個開發者分配的唯一ID;32位字符,全局唯一
(2).authToken:用戶注冊后,為每一個開發者分配的與accountSid對應的唯一秘鑰32位字符,全局唯一
(3).appId:應用ID,創建應用時,平臺分配的唯一ID;32位字符,全局唯一
(4).AS:應用服務器
(5).A路:主叫側通話
(6).B路:被叫側通話
玖云平臺接口對接流程如下:
(1).注冊玖云平臺賬號
(2).進行開發者資質認證
開發者提交資質認證后,需要平臺工作人員進行信息正確性及合法性審核,審核通過后可使用平臺全部功能
查看資質認證方法,查看資質認證審核標準。
(3).注冊成功后,登錄“用戶控制中心”,進行應用創建,并配置相關參數
(4).以上準備完成后,正式開始對接玖云平臺的REST接口進行測試。REST接口配合回調通知接口同時使用可以實時獲取接口使用狀態。
查看回調接口說明
(5).玖云平臺提供多種個性化定制功能,用戶可通過“用戶控制中心”設置相關參數,例如鈴音、號碼等。該步驟也可在接口對接之前進行;號碼及鈴音配置后,需要平臺工作人員進行信息正確性及合法性審核,審核通過可進行正常使用
查看鈴音設置方法,查看鈴音審核標準,查看號碼設置方法,查看號碼審核標準
(6).對接完成開始正式使用,使用過程中玖云平臺將持續為您提供售后服務
所有REST接口采用統一的請求包頭。具體定義如下:
Base URL
文檔中所有被引用的地址都有如下Base URL:
https://api.33e9cloud.com
注意: 為了確保數據隱私,平臺的REST API是通過HTTPS方式請求。
請求統一包頭
業務URL格式:Base URL與業務URL相拼接為完整請求URL
主賬號鑒權:/{softVersion}/Accounts/{accountSid}/{Func}/{funcdes}?sig={sigParameter}
HTTP標準包頭字段(必填):
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Content-Length:256;
Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
屬性 | 類型 | 約束 | 說明 |
softVersion | String | 必選 | 當前版本號,使用默認值2016-01-01(暫定) |
accountSid | String | 必選 | 主賬戶Id。由32個英文字母和阿拉伯數字組成的主賬戶唯一標識符 |
sigParameter | String | 必選 | 鑒權參數,請求URL必須帶有此參數,生成規則詳見下方說明 |
Accept | String | 必選 | 客戶端響應接收數據格式:application/xml、application/json |
Content-Type | String | 必選 | 類型application/xml;charset=utf-8 或者 application/json;charset=utf-8 |
Authorization | String | 必選 | 驗證信息,生成規則詳見下方說明 |
Func | String | 可選 | 業務功能,根據業務的需要添加 |
funcdes | String | 可選 | 業務操作,業務功能的各類具體操作分支 |
參數說明:
(1).sigParameter為REST API 鑒權參數
? URL后必須帶有sig參數,例如:sig=AAABBBCCCDDDEEEFFFGGG
? 使用MD5加密(主賬號Id + 主賬號授權令牌 +時間戳);其中主賬號Id和主賬號授權令牌分別對應“用戶控制中心”中accountSid和authToken
? 時間戳是當前系統時間,格式"yyyyMMddHHmmss";時間戳有效時間為24小時,如:20160316142030
? sigParameter參數需要大寫
(2).Authorization是包頭驗證信息
? 使用Base64編碼(主賬戶Id + 冒號 + 時間戳)
? 冒號為英文冒號
? 時間戳是當前系統時間,格式"yyyyMMddHHmmss",需與sigParameter中時間戳相同
(3).Func描述業務功能,funcdes描述業務功能的具體操作
例如:專線語音為/Calls/callback
(4).支持json及xml兩種格式
(5).時間戳有效期為當前北京時間前后的12小時(共24小時),為了適應全球化用戶
數據報文格式
玖云平臺REST接口支持兩種主流的報文格式:XML和JSON。通過請求包頭的字段Content-Type及Accept,即可決定請求包體和響應包體的格式。
下方示例,表示請求類型格式是XML,要求服務器響應的包體類型也是XML:
Content-Type:application/xml;charset=utf-8;Accept:application/xml;
下方示例,表示請求類型格式是JSON,要求服務器響應類型也是JSON:
Content-Type:application/json;charset=utf-8;Accept:application/json;
1 概述
2 名詞解釋
3 接入流程
4 請求統一包頭