數心開放接口V1.3

1、提交呼叫接口

簡要描述:

  • 提交呼叫接口

請求URL:

  • /webapi.php?act=call

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
mynumber string 分機號碼,由管理員提供
callnumber string 被叫號碼
second_route string 是否調用第二路由, 值為1或0
timeStamp int 當前時間戳
sign string Md5(appid+timeStamp+app_key)

請求示例
webapi.php?act=call&appid=3003&callnumber=18280273993&mynumber=18818872699&timeStamp=145879634662&&sign=23dxds2sw

return_url由管理員分配appid、appkey時配置。
返回示例

  1. 返回值
  2. {
  3. "code": 1,
  4. msg”: “”, //消息
  5. "data": {
  6. "orderid": "XA2015091409573318818876699", //訂單號
  7. "showno": 02037862143,020987323,028987632 , //回撥顯示號碼
  8. }
  9. }

返回參數說明

參數名 類型 說明
code int 返回碼
msg string 消息
orderid string 訂單號
showno string 回撥顯示號碼

備注

code 返回碼,1成功 -1appid錯誤 -2 IP受限 -3簽名不正確 -4超過並發數.(對於包月用戶) -5 不在呼叫時間段 -6 已呼叫 -7 餘額不足 -11.線路繁忙

2、呼叫回調方法

簡要描述:

  • 呼叫回調接口

請求URL:

  • 回調地址+參數

請求方式:

  • GET

請求參數:

參數名 必選 類型 說明
orderid string 訂單號
state string 狀態 1,成功 0失敗
fee_time string 通話時間(分鍾)
hold_time string 通話時間(秒)
start_time int 開始時間
end_time int 結束時間
msg string 錯誤信息

返回示例

  1. 回調地址?orderid=1234&state=1&fee_time=1&hold_time=30&msg=sucess

返回說明

回調的時候,處理成功,返回1. 返回後,將不再異步回調. 否則會有3次的回調機會

3、餘額查詢

簡要描述:

  • 餘額查詢

請求URL:

  • /webapi.php?act=getUserInfo

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
timeStamp int 當前時間戳
sign string Md5(appid+timeStamp+app_key)

4、播放驗證碼

簡要描述:

  • 播放驗證碼

請求URL:

  • /webapi.php?act= playcheck

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
callnumber string 用戶手機號碼
timeStamp int 當前時間戳
sign string Md5(appid+timeStamp+app_key)

返回示例

5、創建坐席分機

簡要描述:

  • 創建坐席分機

請求URL:

  • /webapi.php?act= createphones

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
phones string 用戶手機號碼,要聯通電信的130,131,132,155,156,185,186,133,153,180,181,189
pass string 密碼
verifycode string 驗證碼
timeStamp int 當前時間戳
sign string Md5(appid+timeStamp+app_key)

6、刪除坐席分機

簡要描述:

  • 刪除坐席分機

請求URL:

  • /api/user/register

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
phones string 坐席分機號
timeStamp int 當前時間戳
sign int Md5(appid+timeStamp+app_key)

7、查詢坐席分機

簡要描述:

  • 查詢坐席分機

請求URL:

  • /webapi.php?act= queryphones

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
phones string 坐席分機號
timeStamp int 當前時間戳
sign string Md5(appid+timeStamp+app_key)

8、發送短信

簡要描述:

  • 發送短信

請求URL:

  • /webapi.php?act=sms

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
mobiles string 發送號碼
type int 1:驗證類型 2:通知類型 3:營銷類型
timeStamp int 當前時間戳
content int 發送內容(注:該參數不需要加密 內容編碼為UTF-8 進行urlencode傳遞)
sign int Md5(appid+timeStamp+app_key)

9、坐席統計

簡要描述:

  • 分機統計

請求URL:

  • /webapi.php?act=phones_record

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
mobiles string 號碼
starttime string 統計開始日期(格式如:2018-02-01)
endtime string 統計結束日期(格式如:2018-02-01)
page int 當前頁碼(每頁10條記錄)
timeStamp int 當前時間戳
sign string Md5(appid+timeStamp+app_key)

10、分機統計

簡要描述:

  • 分機統計

請求URL:

  • /webapi.php?act=phones_record

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
mobiles string 號碼
starttime string 統計開始日期(格式如:2018-02-01)
endtime string 統計結束日期(格式如:2018-02-01)
page int 當前頁碼(每頁10條記錄)
timeStamp int 當前時間戳
sign string Md5(appid+timeStamp+app_key)

11、批量加入機器人呼叫隊列

簡要描述:

  • 批量加入機器人呼叫隊列

請求URL:

  • /webapi.php?act=addrobotrecord

請求方式:

  • GET

參數:

參數名 必選 類型 說明
appid string 用戶id
phones string 號碼,多個號碼用“,”隔開,數量不可超過5000個
backurl string 呼叫結果異步通知回調url
timeStamp int 當前時間戳
sign string Md5(appid+timeStamp+app_key)
template_id string 模板ID

返回示例

  1. {
  2. "code": 1,
  3. "data": {
  4. "orderid":21202555654315132,
  5. }
  6. }

返回參數說明

異步通知回調backurl參數

12、機器人呼叫返回結果

簡要描述:

  • 機器人呼叫返回結果

參數:

參數名 必選 類型 說明
state string 0.隊列中1.已提取 2. 正在呼叫 3.呼叫結束
record_url string 下載地址
orderid string 呼叫id
phones string 電話
appid string 請求的appid
level string 返回的等級。”A” => “意向客戶”, “B” => “一般意向”, “C” => “簡單對話”, “D” => “明確拒絕”, “E” => “未接通”
phones_state string 電話接通的狀態,具體參考下麵
desc string 機器人記錄的標簽,如有房子,有車子(要模板配置才有)
start_time string 開始時間
end_time string 結束時間
fee_time string 計費時長
details Struct 具體的機器人跟客戶的對話記錄

phones_state的值
‘called’ => ‘已接通’,
‘power off’ => ‘關機’,
‘does not exist’ => ‘空號’,
‘out of service’ => ‘停機’,
‘hold on’ => ‘正在通話中’,
‘not convenient’ => ‘無法接通’,
‘not in service’ => ‘暫停服務’,
‘busy now’ => ‘用戶正忙’,
‘not a local number’ => ‘撥號方式不正確’,
‘barring of incoming’ => ‘呼入限製’,
‘call reminder’ => ‘來電提醒’,
‘forwarded’ => ‘呼叫轉移失敗’,
‘line is busy’ => ‘網絡忙’,
‘not answer’ => ‘無人接聽’,
‘defaulting’ => ‘欠費’,
‘cannot be connected’ => ‘無法接聽’,
‘number change’ => ‘改號’,
‘line fault’ => ‘線路故障’,
‘redial later’ => ‘稍後再撥’,

返回示例
接口處理完成後需求響應返回success

  1. {
  2. " state ":3
  3. " record_url ":下載地址URL
  4. "orderid":21202555654315132,
  5. "phones":13726865325,
  6. "start_time":1520835717,
  7. "end_time":1520835721,
  8. "fee_time":1520835721,
  9. "hold_time":1520835721,
  10. "details":{
  11. (
  12. "create_time":1517974838
  13. "content":什麽啊?我們這邊信號不好
  14. "url":http://120.77.22.229/downwav.php?url=20180207/70715918838905_9fe2ef80-0bb8-11e8-af4a-4938eb974e44_1.wav&sign=98917990fb3311d15200bec8df0103cf&type=2
  15. "is_robot":1
  16. )
  17. }
  18. }
  19. }
網站地圖:sitemap
网站地图:sitemap