文档

电话号码注册和同步

更新时间:

本文为您介绍与电话号码注册、同步相关的接口说明。

前提条件

在进行号码注册和同步前,您需要完成嵌入式注册流程以及WABAID和PID关联。

操作流程

同步号码信息-ChatappSyncPhoneNumber

通过调用此接口来实现已绑定的WABA下的所有号码信息同步。

接口文档

ChatappSyncPhoneNumber - 同步号码信息

示例

正常返回示例(JSON格式):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "无",
  "PhoneNumbers": [
    {
      "UpQueue": "alicom-09399200-queue",
      "PhoneNumber": "8613800001234",
      "StatusQueue": "alicom-09399200-queue",
      "VerifiedName": "Alibaba",
      "StatusCallbackUrl": "https://www.alibaba.com/status",
      "UpCallbackUrl": "https://www.alibaba.com/inbound\n",
      "QualityRating": "GREEN",
      "Status": "PENDING",
      "CodeVerificationStatus": "VERIFIED",
      "NameStatus": "Approval",
      "MessagingLimitTier": "TIER_10",
      "NewNameStatus": "Approval"
    }
  ]
}

查询号码验证状态-GetPhoneNumberVerificationStatus

通过调用当前接口来获取号码的验证状态,此接口一般用于在号码注册时判断是否需要重新获取验证码。

说明

号码一次验证的有效期一般为14天,即一次验证后14天内不用重新获取验证码进行验证。

接口文档

GetPhoneNumberVerificationStatus - 查询号码验证状态

示例

正常返回示例(JSON格式):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "无",
  "Data": {
    "PhoneNumber": "8613900001234",
    "Id": "2224342624",
    "CodeVerificationStatus": "VERIFIED"
  }
}

获取号码验证码-GetChatappVerifyCode

通过调用当前接口来获取验证码。

接口文档

GetChatappVerifyCode - 获取号码验证码

示例

正常返回示例(JSON格式):

{
  "RequestId": "1612C226-E271-4CFE-9F18-4066D55****",
  "Code": "OK",
  "Message": "无"
}

号码校验并注册-ChatappVerifyAndRegister

调用此接口用于提交验证码并进行注册。当已经获取号码验证码但是号码验证状态为未验证时,调用接口提交验证码进行注册。

接口文档

ChatappVerifyAndRegister - 号码校验并注册

示例

正常返回示例(JSON格式):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "None"
}

号码注册-ChatappPhoneNumberRegister

可先调用查询号码验证状态接口查询到号码是否已经验证,如果号码已经验证,可直接调用此接口完成号码注册操作,不需要客户重新获取验证码进行验证。

接口文档

ChatappPhoneNumberRegister - 号码注册

示例

正常返回示例(JSON格式):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "无"
}

查询号码商业信息-QueryPhoneBusinessProfile

调用此接口以查询注册号码显示给用户的商业信息。

接口文档

QueryPhoneBusinessProfile - 查询号码商业信息

示例

正常返回示例(JSON格式):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "Address": "长沙",
    "Description": "描述",
    "Vertical": "零售",
    "Email": "aa@aliyun.com",
    "ProfilePictureUrl": "https://....img",
    "Websites": [
      "https://alibaba.com"
    ]
  }
}

修改号码商业信息-ModifyPhoneBusinessProfile

调用此接口修改注册号码显示给用户的商业信息。

接口文档

ModifyPhoneBusinessProfile - 修改号码商业信息

示例

正常返回示例(JSON格式):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "SUCCESS"
}
  • 本页导读 (1)
文档反馈