{
"id": "1234567890123456",
"wabaId": "whatsapp-business-account-id",
"phoneNumber": "+16315551111",
"displayPhoneNumber": "+1 631-555-1111",
"businessUsername": "acme.support",
"businessUsernameStatus": "not_set",
"requestedBusinessUsername": "acme.help",
"businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z"
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Retrieve a phone number business username
Retrieves the Business Username state for a WhatsApp business phone number. The response reflects YCloud’s latest known phone number state. If the phone number has no locally stored Business Username state, YCloud may sync the current username state from Meta before returning the response.
{
"id": "1234567890123456",
"wabaId": "whatsapp-business-account-id",
"phoneNumber": "+16315551111",
"displayPhoneNumber": "+1 631-555-1111",
"businessUsername": "acme.support",
"businessUsernameStatus": "not_set",
"requestedBusinessUsername": "acme.help",
"businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z"
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Authorizations
Path Parameters
WhatsApp Business Account ID.
"whatsapp-business-account-id"
Response
Successfully retrieved the object.
Business Username state for a WhatsApp business phone number.
Phone number ID.
"1234567890123456"
WhatsApp Business Account ID.
"whatsapp-business-account-id"
Display phone number.
"+1 631-555-1111"
Active Business Username. The value is a plain username without @.
"acme.support"
Business Username state for a WhatsApp business phone number.
not_set: No active or pending Business Username exists.active: A Business Username is active.reserved: A requested Business Username is reserved by Meta and may still be under review.pending_review: Legacy compatibility value for an under-review request. New writes usereserved. If an active username exists while a new request is reserved or under review,businessUsernameStatusisreserved,businessUsernamecontains the still-active username, andrequestedBusinessUsernamecontains the requested username.
not_set, active, pending_review, reserved Last requested Business Username that is still under review. This value can coexist with an active businessUsername while the new request is pending.
"acme.help"
The time when the Business Username state was last updated.
"2026-05-26T12:00:00.000Z"