Skip to main content

GetAccountPhoneList

To get a list of all phone numbers associated with a WhatsApp Business account.

Request Parameters

NameTypeDescriptionRequired
ActionstringValue: GetAccountPhoneList.YES
AccountIdintAccount ID.YES

Request Example

{
"Action": "GetAccountPhoneList",
"AccountId": 8899
}

Response Parameters

NameTypeDescription
ActionstringGetAccountPhoneListResponse.
RetCodeint0 for success. Error Codes
MessagestringReturn message.
RequestIdstringRequest id.
DataobjectReturn data.

Data Parameters

NameTypeDescription
PhoneListarrayPhones of account.

PhoneList Parameters

NameTypeDescription
NumberstringPhone number.
CountrystringPhone belong country.
StatusstringStatus
QualityRatingstringQuality
DisplayNamestringDisplay name.
MessagingLimitstringMessagingLimit

Response Example

{
"Action": "GetAccountPhoneListResponse",
"Data": {
"PhoneList": [
{
"Number": "447864xxxx86",
"Country": "UK",
"Status": "",
"QualityRating": "",
"DisplayName": "",
"MessagingLimit": ""
},
{
"Number": "447743xxxx87",
"Country": "UK",
"Status": "CONNECTED",
"QualityRating": "GREEN",
"DisplayName": "UCloud Information Technology (HK) Limited",
"MessagingLimit": "TIER_250"
}
]
},
"Message": "",
"RequestId": "702f7f18-c242-4612-97fd-4e41fc161fa7",
"RetCode": 0
}