全部產品
Search
文件中心

Chat App Message Service:電話號碼註冊和同步

更新時間:Jul 26, 2024

本文為您介紹與電話號碼註冊、同步相關的介面說明。

前提條件

在進行號碼註冊和同步前,您需要完成嵌入式註冊流程以及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"
}