修改呼叫记忆数据API
典型场景
语音回呼应用开启了呼叫记忆功能，SP调用“语音回呼场景API”进行呼叫后，若需要更改被叫用户回呼时接听的号码，可调用“修改呼叫记忆数据API”。
接口功能
若语音回呼应用开启了呼叫记忆功能，调用语音回呼场景API进行呼叫时，平台会保存呼叫记忆数据（最大168小时，即7天），被叫用户可直接回呼到原主叫用户。调用“修改呼叫记忆数据API”可修改平台保存的呼叫记忆数据中的主叫用户。
如果重复调用该接口，接口参数值会覆盖前一次调用时的参数值。
使用说明
- 前提条件
- 已通过“应用管理”页面获取该语音回呼能力的app_key和APP接入地址。
- 已调用“大客户SP简单认证API”登录鉴权，获取access_token。access_token有效期为48小时，在有效期“expires_in”还剩下1/4时，需要调用“刷新授权API”重新获取新的access_token。
- 创建语音回呼应用时已开启呼叫记忆功能，并已调用语音回呼场景API进行呼叫。
- 注意事项
无。
- 使用限制
无。
接口类型
请求方法 |
POST |
|
|---|---|---|
访问URI |
/rest/caas/callrecord/callbacknumber/v1.0 |
|
通信协议 |
HTTPS |
|
请求参数
参数名称 |
是否必选 |
参数类型 |
默认值 |
说明 |
|---|---|---|---|---|
app_key |
是 |
String(1-32) |
无 |
语音回呼能力唯一标识。从“应用管理”页面获取。 |
access_token |
是 |
String(1-128) |
无 |
此参数值必须是调用“大客户SP简单认证API”即fastlogin鉴权接口，在RTC业务平台成功登录后，由RTC业务平台返回成功响应消息的access_token参数值。 |
参数名称 |
是否必选 |
参数类型 |
默认值 |
说明 |
|---|---|---|---|---|
Content-Type |
是 |
String |
无 |
固定填 application/json; charset=UTF-8。 |
参数名称 |
是否必选 |
参数类型 |
默认值 |
说明 |
|---|---|---|---|---|
callerNbr |
是 |
String(1-32) |
无 |
呼叫记忆数据中的原主叫号码，即调用“语音回呼场景API”发起呼叫中的主叫号码。
|
changedCallerNbr |
是 |
String(1-32) |
无 |
呼叫记忆数据中修改后的主叫号码，调用“语音回呼场景API”发起呼叫中的被叫号码回呼时，会呼叫该号码。
|
validTime |
否 |
Integer |
需向管理员确认 |
此字段为修改主叫号码的有效时间，超过有效时间后，修改后的主叫号码失效，回呼会转接到原主叫号码。 取值范围：1~168，单位为小时。默认时长需向管理员确认。 |
响应参数
参数名称 |
是否必选 |
参数类型 |
默认值 |
说明 |
|---|---|---|---|---|
resultcode |
是 |
String(1-32) |
无 |
请求返回的结果码。 |
resultdesc |
是 |
String(1-128) |
无 |
请求返回的结果描述。 |
结果码
响应码 |
结果码 |
英文描述 |
中文描述 |
处理方法 |
|---|---|---|---|---|
200 |
0 |
Success. |
成功。 |
无需处理。 |
500 |
1010001 |
Internal system error. |
系统错误。 |
请联系管理员处理。 |
403 |
1010002 |
Invalid request. |
非法请求。 |
检查请求携带的参数格式是否都合法。 |
1010003 |
Invalid app_key. |
无效的app_key。 |
检查请求携带的app_key是否填写正确，app_key从应用管理页面获取，若填写正确，请在应用管理页面检查请求携带的app_key所属应用状态是否正常。 |
|
1010004 |
Invalid access_token. |
access_token无效。 |
检查app_key、access_token是否填写正确。app_key从“应用管理”页面获取，access_token是调用“大客户SP简单认证API”或“刷新授权API”时返回的成功响应消息的access_token参数值。access_token有效期为48小时，在有效期“expires_in”还剩下1/4时，需要调用“刷新授权API”重新获取新的access_token。 |
|
1010005 |
Expired access_token. |
access_token已过期。 |
调用“刷新授权API”重新获取access_token。 |
|
1010040 |
The app_key is not allowed to invoke the API. |
app_key没有调用本API的权限。 |
请联系管理员确认该app_key对应的应用是否具有语音回呼能力。 |
|
1016001 |
The record does not exist. |
记录不存在。 |
检查请求携带的callerNbr和app_key是否填写正确（app_key从应用管理页面获取），并确保使用该callerNbr和app_key调用过“语音回呼场景API”。 |
|
1020166 |
The app client ip is not in ip white list. |
对端app IP不在白名单列表中。 |
联系管理员检查IP白名单是否配置正确。 |
接口示例
- 请求示例
POST /rest/caas/callrecord/callbacknumber/v1.0?app_key=appkey&access_token=AccessToken HTTP1.1 Date:Wed, 28 Dec 2016 01:56:46 GMT Host:service.example.com Accept:*/* Content-Type:application/json; charset=UTF-8 Content-Length:86 { "callerNbr":"+8613800000021", "changedCallerNbr":"+867552800008", "validTime":72 } - 响应示例
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: 46 { "resultcode":"0", "resultdesc":"Success" }
相关文档
相关产品
