1、全局接口介绍

全局接口目前提供账号管理类功能,目前提供四个接口:查询账号余额、修改账号密码、获取录音文件的URL、查询服务器当前时间戳。

2、接口地址与交互方式

接口地址:https://api.yunxinshi.com:8081/GlobalInterface.do

交互方式:用户系统以HTTPS POST的方式向服务器(上述接口地址)发送XML数据包,服务器接收并通过验证后返回执行或查询结果。

3、查询账号余额(QueryBalance)


功能说明:
该接口用于查询账号当前余额。

发送的XML数据包:
<xml>
   <ActionType>QueryBalance</ActionType>
   <UserName></UserName>
   <Token></Token>
</xml>


发送的XML数据包参数说明:

参数必要性含义
ActionType必填
UserName必填
Token必填

返回值:
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <Balance></Balance>
</xml>


返回值参数说明:

参数含义
errorcode
errmsg
Balance

4、修改账号密码(UpdateAccountPWD)


功能说明:
该接口用于修改账号密码。

发送的XML数据包:
<xml>
   <ActionType>UpdateAccountPWD</ActionType>
   <UserName></UserName>
   <Token></Token>
   <NewPassword></NewPassword>
</xml>


发送的XML数据包参数说明:

参数必要性含义
ActionType必填
UserName必填
Token必填
NewPassword必填

返回值:
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
</xml>


返回值参数说明:

参数含义
errorcode
errmsg

5、获取录音文件的URL(GetRecordURL)


功能说明:
该接口用于获取某个已经执行完毕的任务的所有录音文件。考虑到用户信息的保密问题,云信使业务产生的录音文件存储于与公网隔离的录音服务器,当用户需要下载录音时,通过调用本接口,接口将返回存储该录音文件的临时URL(文件仅保留600秒,过期未下载需重新获取)。

发送的XML数据包:
<xml>
   <ActionType>GetRecordURL</ActionType>
   <UserName></UserName>
   <Token></Token>
   <TaskSN></TaskSN>
</xml>


发送的XML数据包参数说明:

参数必要性含义
ActionType必填
UserName必填
Token必填
TaskSN必填

返回值:
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <RecordCount></RecordCount>
   <RecordURL></RecordURL>
   <ExpiredTime></ExpiredTime>
</xml>


返回值参数说明:

参数含义
errorcode
errmsg
RecordCount
RecordURL
ExpiredTime

6、查询服务器当前时间戳(QueryTimeStamp)


功能说明:
该接口用于查询服务器当前的UNIX时间戳,查询时间戳可以用于比对用户系统与云信使系统之间的时间差,以便准确计算某些日志和回调消息的实际时间差。

发送的XML数据包:
<xml>
   <ActionType>QueryTimeStamp</ActionType>
   <UserName></UserName>
   <Token></Token>
</xml>


发送的XML数据包参数说明:

参数必要性含义
ActionType必填
UserName必填
Token必填

返回值:
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <TimeStamp></TimeStamp>
</xml>


返回值参数说明:

参数含义
errorcode
errmsg
TimeStamp