All Products
Search
Document Center

Chat App Message Service:Manage phone numbers

Last Updated:Jul 06, 2023

This topic describes how to manage phone numbers by calling related API operations. You can call these API operations to query all phone numbers of a specified customer as well as the status and quality rating of these phone numbers.

Procedure

Query all phone numbers and the status of these numbers under a specified customer

You can call this operation to query the status of phone numbers that are used to send messages under a specified customer.

You can query the following information about phone numbers: the list of phone numbers, the names of the companies with which the phone numbers are associated, the callback URLs to which status reports are sent, the callback URLs to which mobile originated (MO) messages are sent, the quality rating of the phone numbers, the status of the phone numbers, the verification status of the phone numbers, and the maximum number of messages that can be sent by using the phone numbers.

API reference

QueryChatappPhoneNumbers

Examples

Sample success responses in JSON format

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "SUCCESS",
  "PhoneNumbers": [
    {
      "UpQueue": "Alicom-Queue-****-ChatAppInbound",
      "PhoneNumber": "8613800000",
      "StatusQueue": "Alicom-Queue-****-ChatAppStatus",
      "VerifiedName": "Alibaba",
      "StatusCallbackUrl": "https://ali.com/status",
      "UpCallbackUrl": "https://ali.com/inbound",
      "QualityRating": "GREEN",
      "Status": "CONNECTED",
      "CodeVerificationStatus": "VERIFIED",
      "NameStatus": "Approval",
      "MessagingLimitTier": "TIER_10",
      "NewNameStatus": "Approval"
    }
  ]
}

Query the information about a WABA you associate with ChatAPP

You can call this operation to query the information about a WhatsApp Business account (WABA) you associate with ChatAPP.

You can query the following information: the review status of the WABA, the WABA name, the currency, the WABA ID, and the message template namespace.

API reference

QueryChatappBindWaba

Examples

Sample success responses in JSON format

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "SUCCESS",
  "Data": {
    "Name": "Alibaba",
    "Currency": "USD",
    "Id": "20393988393993***",
    "MessageTemplateNamespace": "90E63D28-E31D-1EB2-8939-A9486641****",
    "AccountReviewStatus": "APPROVED"
  }
}