CreateSmsSign - 短信下发标签生成

更新时间:
复制 MD 格式

员工B通过工作号X向客户A下发短信场景中,员工B使用客户端向客户A 发送短信,客户端须通过本接口获取“短信下发标签”,并在短信内容尾部中添加该“标签”。工作号平台通过“标签”解析出真实被叫A号码,下发短信到A号码。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dypls:CreateSmsSign

create

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ReqId

string

是

请求去重 ID,最大长度为 20 位,请确保请求 ID 的原子性。

564**********879

CallerParentId

integer

否

客户 UID,系统自动获取,无需输入。

-

CustomerPoolKey

string

是

号码池 key。

FC5**********************a1a

CalledNo

string

是

收信人号码。

178****3614

CallingNo

string

是

发信人号码。

150****6539

返回参数

名称

类型

描述

示例值

object

返回结果。

AccessDeniedDetail

string

访问被拒绝详细信息。

0

Message

string

返回信息。

成功

Data

object

短信签名创建结果。

{"CalledNoSign":"sign23343466"}

CalledNoSign

string

短信接收者号码签名串(加到短信内容中供解析真实被叫号码)

sign23343466

Code

string

返回状态码,取值:

  • 0000:表示成功。

其他表示失败。

0000

Success

boolean

返回是否成功,取值:

  • true:表示成功。

  • false:表示失败。

false

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "0",
  "Message": "成功",
  "Data": {
    "CalledNoSign": "sign23343466"
  },
  "Code": "0000",
  "Success": false
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。