隐私通话接口

通过隐私通话接口,您可以实现隐私通话功能 (A、B两个号码通过中间号通话,保护双方隐私。)

号码绑定

URL: https://call.yunpian.com/v2/call/bind.json

功能说明:绑定号码

访问方式:POST

参数:

参数名 类型 是否必须 描述 示例
apikey String 用户唯一标识 9b11127a9701975c734b8aee81ee3526
from String 需要绑定的号码 +8615012341234
to String 需要绑定的号码 +8615011112222
duration Intger 有效时长,单位:秒 600
area_code String 区号,期望anonymous_number所属的地区 +8621(021)

注:

1.from、to不存在方向问题,可以任意顺序传入

2.当前area_code仅支持+8621(021),其他地区将陆续开放。如果不传该区号,将随机绑定全国各地的号码;如果传递该区号,则仅会绑定到该区号对应的号码,如果传递的区号没有对应的号码资源,会绑定失败。

3.所有号码格式按照E.164格式规范,若传入格式不符合E.164规范则按照大陆号码格式处理成E.164

调用成功的返回值示例:

{
    "message_id": "8dba7c44e0ee4062ab2ac61d3e9ce7cf",
    "anonymous_number": "+862112345678"
}

号码解绑

URL: https://call.yunpian.com/v2/call/unbind.json

功能说明:解绑号码

访问方式:POST

参数:

参数名 类型 是否必须 描述 示例
apikey String 用户唯一标识 9b11127a9701975c734b8aee81ee3526
from String 需要绑定的号码 +8615012341234
to String 需要绑定的号码 +8615011112222
duration Intger 延迟解绑的时间,单位:秒,默认为0,0表示立即解除绑定 0

注:

1.from、to不存在方向问题,可以任意顺序传入

2.所有号码格式按照E.164格式规范,若传入格式不符合E.164规范则按照大陆号码格式处理成E.164

{
    "code": 0,
    "msg": "OK"
}

话单获取

URL: https://call.yunpian.com/v2/call/pull.json

功能说明:话单获取

访问方式:POST

备注:需要联系客服开通

参数:

参数名 类型 是否必须 描述 示例
apikey String 用户唯一标识 9b11127a9701975c734b8aee81ee3526
page_size Integer 每页个数,最大100个,默认20个 20

调用成功的返回值示例:

[
    {
        "id": "f2a4783f8d0e43cd89bd0804d8a9e7fb",
        "message_id": "e31538c3553c4867ab118e52f939ec31",
        "from": "+8615012341234",
        "to": "+8615011112222",
        "user_start_time": "2016-04-01 22:29:37", // 主叫发起呼叫的时间
        "user_receive_time": "2016-04-01 22:29:46",// 被叫应答的时间
        "call_end_time": "2016-04-01 22:29:53", // 通话结束的时间
        "duration": 7, // 通话时长:end_time - receive_time
        "fee" : 0.15 , // 费用,单位:元
        "status": "SUCCESS", // 接听状态有:SUCCESS/FAIL
        "error_msg": null, // 接收失败的原因,如:"用户未应答"
        "anonymous_number": "02112345678" // 匿名号码
    }
]

推送话单

推送方式:POST

推送的数据格式:

参数名 = 经过urlencode编码的数据

形式如:

voice_call_status = urlencode(json)

服务端推送数据形式如下:

curl --data "voice_call_status=url_encode_json" http://your_receive_url_address

其中json数据示例为:

[
    {
        "id": "f2a4783f8d0e43cd89bd0804d8a9e7fb",
        "message_id": "e31538c3553c4867ab118e52f939ec31", // 语音绑定记录id,32位的唯一字符串
        "from": "+8615012341234",
        "to": "+8615011112222",
        "user_start_time" : "2016-04-01 14:29:12", // 主叫发起呼叫的时间
        "user_receive_time": "2016-04-01 14:29:18", // 被叫应答时间
        "call_end_time": "2016-04-01 14:30:18", // 被叫应答时间
        "duration": 60, // 通话时长,单位:秒
        "fee" : 0.15 , // 话费,单位:元
        "anonymous_number" : "+862112345678", // 匿名号码,主叫呼叫的匿名号码
        "status": "SUCCESS" ,//接听状态有:SUCCESS/FAIL
        "error_msg": null //接收失败的原因,如:"用户未应答"
    }
]

接收到数据后,请从参数voice_call_status中取值,取到值使用urldecode解码后为实际json格式数据 处理成功请返回字符串"SUCCESS"或"0",其他返回值将被认为是失败。该接口失败重试次数为3次,每次间隔5分钟。