隐私保护通话 PRIVATENUMBER-短信通知接口:响应参数

时间:2024-04-23 15:42:46

响应参数

客户服务器接收到 隐私保护通话 平台的短信事件通知后,根据不同的模式返回不同响应消息。

  • Notify模式

    返回无消息体的200响应。

  • Block模式

    响应必须参照表7携带消息体,返回对短信事件的处理操作。

    表7 响应消息参数说明

    参数名称

    是否必选

    参数类型

    说明

    actions

    SMS ActionType[]

    短信操作指示。

    表8 SMSActionType定义

    参数名称

    是否必选

    参数类型

    说明

    operation

    String(1-32)

    操作类型:

    • vNumberRoute:转发短信。
    • DiscardMessage:丢弃短信。

    message

    MessageInfo

    短信操作信息。

    仅当operation取值为“vNumberRoute”时有效。

    extParas

    JsonArray

    预留参数,当前版本无需关注。

    userData

    String(1-256)

    用户自定义数据。

    • 不允许携带以下字符:“{”,“}”(即大括号)。
    • 不允许包含中文字符,如果包含中文字符请采用Base64编码。
    说明:

    使用该参数的场景请联系华为云客服获取。

    表9 MessageInfo定义

    参数名称

    是否必选

    参数类型

    说明

    called

    String(1-64)

    真实接收方号码。

    号码仅支持全局号码格式(包含国家码),比如+86138****7022。

    calling

    String(1-64)

    真实发送方号码。

    和请求参数中的calling参数的取值保持一致。

    号码仅支持全局号码格式(包含国家码),比如+86138****7021。

support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0008.html