云服务器内容精选

  • 接口示例 请求示例 GET /rest/provision/voice/record/v1.0? fileName=1200_366_0_20161228102743.wav&recordDomain=huawei HTTP1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey" x-aksk: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="****",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx 响应示例 HTTP/1.1 301 Moved Permanently Location: **** Connection: close Content-Length: 0
  • 请求参数 表2 请求URL参数说明 参数名称 是否必选 参数类型 默认值 说明 fileName 是 String(1-128) 无 录音文件名。通过“呼叫状态和话单通知API”的recordObjectName参数获取。 recordDomain 是 String(1-128) 无 录音文件存储的服务器 域名 ,通过“呼叫状态和话单通知API”的recordDomain参数获取。 表3 请求Headers参数说明 参数名称 是否必选 参数类型 说明 Content-Type 是 String 固定填写为application/json;charset=UTF-8。 Authorization 是 String 固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 X-AKSK 是 String 取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。 PasswordDigest:根据PasswordDigest = Base64 (HMAC-SHA256 (Password,Nonce + Created))生成。其中,Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可,无需包含+号和空格。 Nonce:客户发送请求时生成的一个随机数,长度为1~128位,可包含数字和大小写字母。例如:66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created:随机数生成时间。采用标准UTC格式,例如:2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同,部分语言可参考表4。 表4 不同编程语言的时间格式 编程语言 时间格式 Java yyyy-MM-dd'T'HH:mm:ss'Z' PHP Y-m-d\TH:i:s\Z Python %Y-%m-%dT%H:%M:%SZ C# yyyy-MM-ddTHH:mm:ssZ Node.js toISOString().replace(/.[0-9]+\Z/, 'Z') 注:Node.js中,使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。
  • 结果码说明 请根据以下结果码进行调测,如果有疑问,可联系管理员进行确认。 表7 响应结果码 响应码 结果码 英文描述 中文描述 处理方法 301 - - - 成功响应,请从Location头域中获取录音文件下载地址。 400 1023006 Authorization not contained in the HTTP header. HTTP消息头未找到Authorization字段。 请检查HTTP消息头中是否携带了Authorization字段。 1023007 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 1023008 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 1023009 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 1023010 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 1023011 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 1023012 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 1023033 HTTP header not found X-AKSK field. HTTP头未找到X-AKSK字段。 请检查HTTP消息头中是否携带了X-AKSK字段。 1023034 UserName not contained in X-AKSK. X-AKSK字段中未找到UserName属性。 请检查X-AKSK字段中的是否携带了Username属性。 1023035 Nonce not contained in X-AKSK. X-AKSK字段中未找到Nonce属性。 请检查X-AKSK字段中的是否携带了Nonce属性。 1023036 Created not contained in X-AKSK. X-AKSK字段中未找到Created属性。 请检查X-AKSK字段中的是否携带了Created属性。 1023037 PasswordDigest not contained in X-AKSK. X-AKSK字段中未找到PasswordDigest属性。 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 1023038 UsernameToken not contained in X-AKSK. X-AKSK中没有携带UsernameToken。 请检查X-AKSK字段中的是否携带了UsernameToken属性。 401 1010010 Invalid digest. PasswordDigest校验失败。 请检查PasswordDigest字段填写是否正确。 1010013 Time out limit. 时间超出限制。 请确认X-AKSK鉴权时,生成随机数的时间与发送请求时的本地时间不能相差太大(具体差值请与管理员确认)。 403 1010002 Invalid request. 非法请求。 请检查请求携带的参数格式是否都合法。 1010003 Invalid app_key. 无效的app_key。 检查请求携带的app_key是否填写正确,app_key从应用管理页面获取,若填写正确,请在应用管理页面检查请求携带的app_key所属应用状态是否正常。 1010007 The ativeState of User is not ACTIVATING. 用户状态未激活。 请检查app_key所属的华为云账户是否处于欠费状态,若处于欠费状态,请参考华为云账户充值完成充值,若没有处于欠费状态,请联系管理员处理。 1012012 Application does not open recording function. 应用未开启录音功能。 请确认请求携带的app_key是否开启了录音功能。 1012007 The record does not exist. 记录不存在。 请确认fileName参数的填写是否正确。 1011006 Under traffic control status 请求者(IP、手机号码)处于流控状态下。 请稍等一分钟再试。 1020166 The app client ip is not in ip white list. 请求发送方app IP不在白名单列表中。 联系管理员检查IP白名单是否配置正确。 1020176 Authentication failed, try again later 鉴权失败,稍后重试 IP因鉴权失败次数过多导致被拉黑,请30分钟后重试,或联系管理员放通该IP。 500 1010001 Internal system error. 系统错误。 请联系管理员处理。 1023001 Internal error. 内部错误。
  • 使用说明 前提条件 已通过“应用管理”页面获取APP_Key,APP_Secret和APP接入地址。 已通过“呼叫状态和话单通知API”获取了录音文件名。 注意事项 响应返回的录音下载地址有效期为30分钟,地址过期后若还需要下载录音文件,请重新调用该接口获取下载地址。 调用获取录音文件下载地址接口需要把connection设置为不支持重定向,再从Location头域中获取到录音文件的下载地址。 若connection设置为支持重定向,则重定向后平台返回的是录音文件的数据流。 使用限制 无。
  • 接口示例 请求示例 POST /rest/httpsessions/click2Call/v2.0 HTTP1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey" x-aksk: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="****",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" Content-Length:xx { "displayNbr":"+86755****8888", "callerNbr":"+86137****0001", "calleeNbr":"+86137****0002", "displayCalleeNbr":"+86755****8888", "userData":"cwgtest" } 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "resultcode":"0", "resultdesc":"Success", "sessionId":"1202_566_0_20161228102743@callenabler.home1.com" }
  • 结果码 请根据以下结果码进行调测,如果有疑问,可联系管理员进行确认。 表6 结果码说明 响应码 结果码 英文描述 中文描述 处理方法 200 0 Success. 成功。 无需处理。 400 1023006 Authorization not contained in the HTTP header. 鉴权失败,请检查鉴权请求正确性。 请检查消息头中是否携带了Authorization,PasswordDigest字段填写是否正确,携带的app_key填写是否正确,且生成随机数的时间与发送请求时的本地时间不能相差太大。 1023007 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 1023008 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 1023009 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 1023010 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 1023011 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 1023012 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 1023033 HTTP header not found X-AKSK field. HTTP头未找到X-AKSK字段。 请检查HTTP消息头中是否携带了X-AKSK字段。 1023034 UserName not contained in X-AKSK. X-AKSK字段中未找到UserName属性。 请检查X-AKSK字段中的是否携带了Username属性。 1023035 Nonce not contained in X-AKSK. X-AKSK字段中未找到Nonce属性。 请检查X-AKSK字段中的是否携带了Nonce属性。 1023036 Created not contained in X-AKSK. X-AKSK字段中未找到Created属性。 请检查X-AKSK字段中的是否携带了Created属性。 1023037 PasswordDigest not contained in X-AKSK. X-AKSK字段中未找到PasswordDigest属性。 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 1023038 UsernameToken not contained in X-AKSK. X-AKSK中没有携带UsernameToken。 请检查X-AKSK字段中的是否携带了UsernameToken属性。 401 1010010 Invalid digest. PasswordDigest校验失败。 请检查PasswordDigest字段填写是否正确。 1010013 Time out limit. 时间超出限制。 请确认X-AKSK鉴权时,生成随机数的时间与发送请求时的本地时间不能相差太大(具体差值请与管理员确认) 403 1010002 Invalid request. 非法请求。 检查请求携带的参数格式是否都合法。 1010003 Invalid app_key. 无效的app_key。 检查请求携带的app_key是否填写正确,app_key从应用管理页面获取,若填写正确,请在应用管理页面检查请求携带的app_key所属应用状态是否正常。 1010006 Invalid Rest API. 无效的Rest API。 检查请求方法填写是否正确。 1010008 The status of the app_key is unavailable. app_key被暂停使用。 请在应用管理页面检查请求携带的app_key所属应用状态是否正常。 1010009 No more APIs can be invoked. API达到调用上限。 请稍等一分钟后再试,并联系管理员申请更高的应用使用配额。 1010010 The flow control upper limit is reached on the platform. 平台达到系统流控上限。 请稍等一分钟后再试。 1010011 The app is not allowed to access a commercial address. APP没有访问商用地址的权限。 请在应用管理页面检查请求携带的app_key所属应用状态是否正常。 1010021 Application unavailable. 应用不可用。 请在应用管理页面检查请求携带的app_key所属应用状态是否正常。 1010023 Invalid display number. 号码填写不合法。 检查displayNbr和displayCalleeNbr参数的填写是否合法,与号码管理页面的“固话号码”保持一致。若合法,请确认该号码是否已申请并下发。申请号码在号码订购页面申请,号码下发后可在号码管理页面查看。 1010024 Invalid caller number. 主叫号码不合法。 检查callerNbr参数的填写是否合法。 1010040 The app_key is not allowed to invoke the API. app_key没有调用本API的权限。 请联系管理员确认该app_key对应的应用是否具有语音回呼能力。 1012001 Resource of number is not to be applied. 资源未申请。 app_key和业务号码未绑定。 1012006 The service number is not applied. 业务号码未申请。 请确认是否申请业务号码。 1012012 Application does not open recording function. 应用未开启录音功能。 请在应用管理页面确认请求携带的app_key是否开启了录音功能。 1013001 Calls exceed the SP limit. 请求次数超过SP配置上限。 请和管理员确认开发者呼叫数量限制。 1013002 Calls exceed the APP limit. 请求次数超过应用配置上限。 请和管理员确认应用呼叫数量限制。 1013003 Calls exceed the display number limit. SP的主显号码受限。 请和管理员确认显示号码呼叫数量限制。 1013004 Callee in blacklist. 被叫用户是黑名单。 被叫号码在运营商黑名单库。 1013010 Caller in blacklist. 主叫用户是黑名单。 主叫号码在运营商黑名单库。 1013011 Callee is not on the whitelist. 被叫用户不在白名单中。 请和管理员确认被叫号码白名单限制。 1013100 Common error code . 未知错误。 请和管理员确认安全管控限制。 1013101 Abnormal call restricted . 呼叫行为异常。 请和管理员确认安全管控限制。 1013111 International callin is forbidden. 国际呼入限制。 请检查请求的号码格式是否为国际号码格式。 1013112 International callout is forbidden. 国际呼出限制。 请检查请求的号码格式是否为国际号码格式。 1013113 Abnormal call duration restricted. 通话时间异常。 请检查请求的号码是否通话时间异常。 1013115 Abnormal call completion rate restricted. 呼叫接通率异常。 请检查请求的号码是否呼叫接通率异常。 1013116 Caller call frequency restricted. 主叫呼叫频次限制。 请检查主叫号码是否有呼叫频次限制。 1013117 Callee call frequency restricted. 被叫呼叫频次限制。 请检查被叫号码是否有呼叫频次限制。 1013118 Service number call frequency restricted. 业务号码呼叫频次限制。 请检查业务号码是否有呼叫频次限制。 1013119 Service number suspend. 业务号码被暂停。 请和管理员确认号码状态。 1013120 Ip address is null. IPv4地址未携带。 请客户接口携带请求发送方IPv4地址。 1013121 Call black time forbidden. 呼叫时段限制。 呼叫时段为休息时段,请工作时段再呼叫。 1013122 Sub enterprise is suspended. 子企业已被暂停。 查看是否因投诉被下线,可查看订购号码时填写的邮箱是否有业务下线通知邮件。 1020165 The number of app_key voice call ports exceeds the upper limit. 超出语音呼叫端口数限制。 请稍等一分钟后再试。建议联系管理员为该应用申请更多的端口配额。 1020166 The app client ip is not in ip white list. 请求发送方app IP不在白名单列表中。 运营商IP地域管控,此地区无法呼通。 1020168 The call is rejected because the login IP of the peer app is blacklisted . 请求发送方app登录IP是黑名单。 运营商IP地域管控,此地区无法呼通。 1020171 The call is rejected because the login IP of the peer app is blacklisted area. 请求发送方app登录IP在受限地域。 运营商IP地域管控,此地区无法呼通。 1020176 Authentication failed, try again later 鉴权失败,稍后重试。 IP因鉴权失败次数过多导致被拉黑,请30分钟后重试,或联系管理员放通该IP。 500 1010001 Internal system error. 系统错误。 请联系管理员处理。 1020001 Parameter error. 参数错误。 检查请求携带的参数格式是否都合法。 1020002 Internal error. 内部错误。 请联系管理员处理。 1020150 The app_key is invalid. app_key无效。 检查请求携带的app_key是否填写正确,app_key从应用管理页面获取,若填写正确,请在应用管理页面检查请求携带的app_key所属应用状态是否正常。 1020151 The bindNum is invalid. 业务号码无效。 业务号码无效,请联系管理员处理。 1020154 Insufficient voice ports. 语音端口不足。 请稍等一分钟后再试,并联系管理员申请扩容语音端口。 1023001 Internal error. 内部错误。 请联系管理员处理。 1023002 Response timeout. 响应超时。 重新发送一次请求。 1040001 south ne error with responseCode: %$ and responseMsg: %$. 南部网元错误。 请联系管理员处理。
  • 请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 Content-Type 是 String 固定填写为application/json;charset=UTF-8。 Authorization 是 String 固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 X-AKSK 是 String 取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。 PasswordDigest:根据PasswordDigest = Base64 (HMAC-SHA256 (Password,Nonce + Created))生成。其中,Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可,无需包含+号和空格。 Nonce:客户发送请求时生成的一个随机数,长度为1~128位,可包含数字和大小写字母。例如:66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created:随机数生成时间。采用标准UTC格式,例如:2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同,部分语言可参考表3。 表3 不同编程语言的时间格式 编程语言 时间格式 Java yyyy-MM-dd'T'HH:mm:ss'Z' PHP Y-m-d\TH:i:s\Z Python %Y-%m-%dT%H:%M:%SZ C# yyyy-MM-ddTHH:mm:ssZ Node.js toISOString().replace(/.[0-9]+\Z/, 'Z') 注:Node.js中,使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 表4 请求Body参数说明 参数名称 是否必选 参数类型 默认值 说明 displayNbr 是 String(4-31) 无 此字段定义主叫用户收到语音通话平台的呼叫时,主叫用户手机终端的来电显示号码。需提前在订购号码页面申请该号码。 号码格式(固话):国家码+区号+固话,与号码管理页面的“固话号码”保持一致。 若该号码为“暂停”状态,语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。 callerNbr 是 String(4-31) 无 此字段定义用户在SP开发的应用中,通过语音回呼功能发起呼叫时所使用的主叫号码。 手机号码格式:+{国家码}{手机号码}。示例:+86135***0002。 固话格式:+{国家码}{区号}{固话号码},其中区号需去掉首位的0。示例:国家码86,区号0755,固话号码28****02,填写为+8675528****02。 displayCalleeNbr 是 String(4-31) 无 此字段定义被叫用户收到语音通话平台的呼叫时,被叫用户终端的来电显示号码。需提前在订购号码页面申请该号码。 该号码可以与displayNbr配置为同一个号码,也可以配置为不同号码。 号码格式(固话):国家码+区号+固话,与号码管理页面的“固话号码”保持一致。 若该号码为“暂停”状态,语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。 calleeNbr 是 String(4-31) 无 此字段定义终端用户在SP开发的应用中通过语音回呼业务发起呼叫时所拨打的被叫号码。 号码格式: 手机号码格式:+{国家码}{手机号码}。示例:+86135****0004。 固话格式:+{国家码}{区号}{固话号码},其中区号需去掉首位的0。示例:国家码86,区号0755,固话号码28****04,填写为+8675528****04。 maxDuration 否 Integer 0 此字段用于设置允许单次通话进行的最长时间,通话时间从被叫接通的时刻开始计算。 取值范围:0~1440分钟 0:系统不主动结束通话,由主被叫双方结束通话。 1~1440:当通话时长达到此配置值,系统主动结束通话。 不携带时,参数值默认为0。 lastMinVoice 否 String(1-128) 无 当maxDuration字段设置为非0时此参数有效。 此参数用于设置最后一分钟放音提示音,此值填写SP定制的放音文件名,例如lastmin_voice1.wav,参数取值有以下两种场景: SP无需定制个性化放音,无需配置此参数,系统将使用默认放音文件,放音内容为:“本次通话时长还剩1分钟”。 SP需要定制个性化放音,接口消息中携带此参数,参数值携带定制的放音文件名,请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。 lastMinToUE 否 String(枚举) both 当maxDuration字段设置为非0时此参数有效。 此字段用于设置最后一分钟放音的播放对象。 toa:仅对主叫用户放音。 tob:仅对被叫用户放音。 both:同时给主叫和被叫用户放音。 不携带时,参数值默认为both。 playPreVoice 否 String(枚举) false 此字段用于设置主叫(callerNbr)应答语音回呼后,呼叫被叫(calleeNbr)前,是否向主叫(callerNbr)播放提示音。 当该参数设置为true时,播放完主叫提示音(preVoice)后才播放主叫等待音(waitVoice)并呼叫被叫(calleeNbr)。 true:播放提示音。 false:不播放提示音。 不携带时,参数值默认为false。 preVoice 否 String(1-128) 无 当playPreVoice字段设置为true时此参数有效。 此字段用于设置主叫(callerNbr)应答语音回呼后,呼叫被叫(calleeNbr)前向主叫播放的提示音,此值填写放音文件名,例如pre_voice1.wav。 SP无需定制个性化放音文件,接口消息中无需携带此参数,系统将使用默认放音“正在为您转接中,请稍后”。 SP需要定制个性化放音文件,接口消息中携带此参数,请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。 waitVoice 否 String(1-128) 无 此字段用于设置主叫应答语音回呼后的等待音,此值填写放音文件名,例如wait_voice1.wav。 SP无需定制个性化放音文件,接口消息中无需携带此参数,系统将使用默认放音,系统边给主叫放音(循环放音)边拨打被叫用户;被叫应答才中止放音。 SP需要定制个性化放音文件,接口消息中携带此参数,请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。 waitVoice可结合calleeMedia使用。 calleeMedia 否 String(枚举) all 该参数用于指定被叫的媒体音播放方式,参数取值范围如下: all:透传被叫端的所有放音。当被叫端返回振铃音等媒体音,则终止主叫的等待音,播放被叫的媒体音,如彩铃音等。 none:不透传被叫所有放音,一直播放主叫的等待音,直到被叫应答或挂机。 fail:只有在被叫回失败放音时(带reason原因值),才终止主叫的等待音、播放被叫的失败放音。 不携带时,参数值默认为all。 statusUrl 否 String(1-128) 无 此参数请采用BASE64编码进行加密。 此字段用于设置SP接收状态上报的URL。 语音通话平台将业务触发过程中通话的状态信息(包括呼出、振铃、摘机和挂机信息)推送至此服务器,SP根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或域名,推荐使用域名。且该域名对应多个服务器,避免单点故障无法接收通知。 URL只能由大小写字母(a-z、A-Z),数字(0-9),中划线(-),英文冒号(:),英文点号(.),以及英文斜杠(/)组成,不支持其它字符。最大128字节。 feeUrl 否 String(1-128) 无 此参数请采用BASE64编码进行加密。 此参数用于设置SP接收话单上报的URL。 语音通话平台将业务产生的话单推送至此服务器。 URL可填写为https://IP:Port或域名,推荐使用域名。且该域名对应多个服务器,避免单点故障无法接收话单。 URL只能由大小写字母(a-z、A-Z),数字(0-9),中划线(-),英文冒号(:),英文点号(.),以及英文斜杠(/)组成,不支持其它字符。最大128字节。 recordFlag 否 String(枚举) false 此字段设置语音回呼通话过程是否录音。 true:开启录音,请在添加应用时开启录音功能。 false:不开启录音。 不携带时,参数值默认为false。 recordHintTone 否 String(1-128) 无 此字段在recordFlag为true时才有效。 此字段用于设置使用录音功能的提示音,参数传值为指定的放音文件名,例如recordhint_voice1.wav。 无需定制个性化放音时,接口消息中无需携带此参数,此时系统可能会放默认提示音,也可能不放,请联系华为云客服确认。 需要定制个性化放音文件时,接口消息中携带此参数,请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。 partyTypeRequiredInDisconnect 否 String(枚举) false 该参数用于指定语音通话平台给开发者发送disconnect的呼叫状态时,通知消息是否需要携带通话主动挂机的用户类型(主叫挂机、被叫挂机、平台挂机)。 该参数取值范围如下: true:需要携带 false:不需要携带 不携带该参数时,默认值为false。 returnIdlePort 否 String(枚举) false 指示是否需要返回平台空闲呼叫端口数量。 true:需要返回 false:不需要返回 不携带该参数时,默认值为false。 userData 否 String(1-256) 无 此字段用于SP开发者自定义呼叫发起时,设置用户的附属信息,应用场景可以是当开发者想要对每一次呼叫的用户进行跟踪时,该参数可以携带用于标识用户的信息,如customerId123。 语音通话平台不对此参数做强制要求,如果开发者传入此参数,语音通话平台会在后续发给SP的通知消息中携带该参数值。 不允许携带以下字符:“{”,“}”(即大括号)。 不允许包含中文字符,如果包含中文字符请采用Base64编码。
  • 响应参数 表5 响应消息参数说明 参数名称 是否必选 参数类型 默认值 说明 resultcode 是 String(1-32) 无 请求返回的结果码。 resultdesc 是 String(1-128) 无 请求返回的结果描述。 sessionId 是 String(1-256) 无 请求返回的会话sessionId,用于标记一路会话。如果请求失败,则sessionId为空表示会话建立失败。 idlePort 否 Integer 无 请求参数中returnIdlePort为true时响应消息携带该参数。 该参数表示平台呼叫端口空闲可用数量,取值范围0~65535。
  • 使用说明 前提条件 已通过“应用管理”页面获取该语音回呼能力的APP_Key,APP_Secret和APP接入地址。 已通过“号码订购”页面向语音通话平台申请以下号码: 若使用定制化主叫端来电显示号码,请确认已申请固话号码(displayNbr)。 若需隐藏主叫号码,使用定制化被叫端来电显示号码,请确认已申请固话号码(displayCalleeNbr)。 若需使用通话录音功能,请确认已向语音通话平台申请该功能。 若使用个性化放音,请确认已按要求制作并通过放音文件管理页面向语音通话平台提交放音文件,包括最后一分钟提示音(lastMinVoice),主叫提示音(preVoice),主叫等待音(waitVoice),录音提示音(recordHintTone),回呼提示音(callBackTone)。 若需订阅呼叫状态和话单通知,请确认已通过应用管理向语音通话平台提交呼叫状态通知URL(statusUrl)和话单通知URL(feeUrl)。若未提交,调用接口时填写也可以。 注意事项 无。 使用限制 无。
  • 故障排除 如何判断华为云服务API接口是否正常?如果不正常如何处理? 调用接口时请求不通,没有任何返回信息,怎么处理? 返回“1010004 Invalid access_token.”错误码如何处理? 返回“1010023 Display number invalid.”错误码如何处理? 在什么场景下会返回“1020165 The appkey call port of using exceeds the limited.”错误码? 请求时遇到1010002非法请求错误如何处理? 在进行语音通话时,被叫号码无法呼起,导致问题的可能原因有哪些? 为什么没有收到呼叫状态通知和话单通知? 为什么通话时间小于3秒的呼叫无法下载录音文件? 语音通话控制台访问异常如何处理? API调用失败如何处理?失败后可以一直不停的调用吗?
  • 呼叫状态和话单通知 如何配置和接收呼叫状态和话单通知?地址是否支持http? 呼叫状态和话单通知什么时候推送? 呼叫状态和话单通知多个用户如何推送? 接收呼叫状态和话单通知后需要返回响应消息吗? 接收呼叫状态和话单通知,参数区分大小写吗? 语音通话的呼叫状态通知和话单通知支持重推吗? 语音通话的通话记录如何获取? 推送的话单中时间未按正常的时区显示,服务器时间和北京时间相差8小时? 如果不想接收呼叫状态和话单通知怎么办? 如何查看通话详情?
  • API&代码样例 access_token有效期是多少?需要每个请求都重新获取access_token吗? 语音回呼有最大通话时长限制吗? 代码样例(JAVA)有什么使用注意事项? 语音通话如何获取APP接入地址、APP_Key和APP_Secret? 语音通话的不同应用可以共用一个access_token吗? 如何实现同时给多个用户发送语音通知? token有效期内多次调用fastlogin接口,只有其中一个token生效,如何处理? 语音回呼场景API,可以只给主叫设置录音提示音吗?主被叫可以都设置不提示吗?
  • 号码相关 号码格式是什么?怎么填写? 语音通话是否支持固话号码及手机号码?如何申请? app_key、开发者账号、固话号码和CallEnabler业务号码(bindNbr)有什么特定的数量关系吗? 语音通话中来电显示什么号码?是否支持自定义来电显示号码? 语音通话的固话号码是否会根据接听号码所属地区而变动?是否可修改? 语音通话怎么进行号码标记? 语音通话的固话号码(displayNbr、displayCalleeNbr)是什么?如何获取? 添加企业中的“是否需要申请固话号码”要选择“是”还是“否”? 语音通话如何查看已申请的号码? 为什么终端上实际显示的号码和调用接口时携带的固话号码不一致? 语音通话一个华为云账号下的固话号码可否转给其它企业的华为云账号使用? 固话号码和绑定号码的归属地必须与企业归属地相同吗? 语音通话是否支持95号码? 语音通话可以申请多个号码吗?都可以申请哪些城市的号码? 语音通话如何退订号码?号码退订后还会扣月租吗? 语音通话能否提供号码证明? 语音通话是否有区域限制?哪些地区不能使用语音通话? 号码更换地区需要重新订购吗?
  • 服务开通相关 如何订购并开通语音通话服务?需要审核多久? 为什么语音通话开通服务时“立即申请”点击不了? 开通服务时,遇到报错该如何处理? 语音通话应用是否能修改、删除? 如果新建一个应用,需要重新申请该应用的固话号码吗? 语音通话最多可添加几个应用?需要添加更多的应用怎么办? 语音通话号码资源下发需要多久? 华为云语音通话服务中,导致企业审核审核不通过的原因有哪些?如何处理? 语音通话的企业管理中,添加了企业信息,多久能审核通过?如何查询审核结果? 语音通话添加企业时的“预估日通话次数”有最低限制吗? 添加企业后,是否支持修改或删除企业信息? 语音通话服务中,创建了多个应用,可以每个应用对应不同的开发者账号和密码吗? 添加号码时,遇到报错该如何处理? 已通过华为云企业实名认证的用户还需要在控制台添加企业信息吗? 为什么添加企业时经办人手持身份证照片不规范? 如果修改华为云账号的实名认证信息,是否影响语音通话的业务? 不再使用语音通话业务了,是否需要退订?如何退订?
  • 放音文件及语音模板配置 放音文件和语音模板必须要审核通过后才可使用吗? 语音通话有哪些可自定义的呼叫提示音,如何上传审核? 语音通话的放音文件是固定的还是要用户上传呢? 语音通知中使用放音文件和语音模板有什么区别? 放音文件的音频格式要求是什么? 一个语音通知可以播放几个语音文件?格式是什么? 想要指定自己的语音通知模板,需要遵循哪些配置规则? 语音模板内容支持小数吗? 如何查看语音模板内容?是否支持下载或迁移? 语音模板中的变量是如何填充的? 语音通知可以设置播放多遍吗,如何设置?