For the complete documentation index, see llms.txt. This page is also available as Markdown.

Number (sender) Callback

Phone number quality update

This event is triggered when the quality status of the submitted sender changes: whatsapp_phone_number_quality_update

Field

Data type

Required

Description

wabaId

String

Yes

WabaId

displayPhoneNumber

String

Yes

sender number

event

String

Yes

Event for message delivery limit change or throughput changeDOWNGRADE: indicates that the business phone number's message limit has been reduced.FLAGGED: indicates that if this business phone number continues to receive negative feedback, its messaging quality will decline.ONBOARDING: indicates that this business phone number is still in the onboarding process.THROUGHPUT_UPGRADE: indicates that the throughput level of this business phone number has been increased to a higher throughput.UNFLAGGED: indicates that if this business phone number continues to receive positive feedback, it is eligible for an increase in its messaging limit.UPGRADE: indicates that the business phone number's message limit has been increased.

messageLimit

String

Yes

Optional values: Unlimited: meaning there is no limit on the number of messages sent 0: indicates that this business phone number has not yet been used to send messages. 50: indicates a message limit of 50 250: indicates a message limit of 250 1000: indicates a message limit of 1,000 10000: indicates a message limit of 10,000 100000: indicates a message limit of 100,000

{
    "id": "fd201190-50dc-4151-baec-1d16c8a704e1",
    "type": "whatsapp_phone_number_quality_update",
    "eventTime": "2023-10-16T13:04:57.644Z",
    "body": {
        "messageLimit": "100000",
        "event": "UPGRADE",
        "displayPhoneNumber": "1086***36726376",
        "wabaId": "1101295***80569"
    }
}

Phone number name update

This event is triggered when the submitted sender name changes: whatsapp_phone_number_name_update

Field

Data type

Required

Description

wabaId

String

Yes

WabaId

displayPhoneNumber

String

Yes

sender number

decision

String

Yes

Indicates the result of the business phone number display name verification process.APPROVED: indicates that the display name has been approved and will now appear at the top of the business phone number profile in the WhatsApp client.DEFERRED: indicates that the decision has been deferred.PENDING: indicates that the decision is still pending further review.REJECTED: indicates that the display name has been rejected. You can edit the name in WhatsApp Manager. Before editing, please review our display name guidelines.

requestedVerifiedName

String

Yes

The business phone number display name collected when the number is created, or the name submitted when editing an approved display name

rejectionReason

String

Yes

If the business phone number display name is rejected, this explains why. Please review our display name guidelines for common rejection reasons. Optional values:NAME_EMPLOYEE_ISSUE: rejected because the display name tends to be a personal name or employee identifier.NAME_ENDCLIENT_NOTRELATED: rejected because the display name tends to be an unrelated business name.NAME_FORMAT_UNACCEPTABLE: rejected because the display name uses an unacceptable format.NAME_INDIVIDUAL_ISSUE: rejected because the display name tends to be a personal name or employee identifier. — NAME_NOT_CONSISTENT rejected because the display name is inconsistent with the business's brand.null: indicates that the name has been accepted.UNKNOWN: rejected for an unknown reason. Please contact customer support

{"id": "fd201190-50dc-4151-baec-1d16c8a704e1","type": "whatsapp_phone_number_name_update","eventTime": "2023-10-16T13:04:57.644Z","body": {"decision": "REJECTED","requestedVerifiedName": "zhangsan","rejectionReason": "NAME_EMPLOYEE_ISSUE","displayPhoneNumber": "108672***726376","wabaId": "110129****080569"}}

最后更新于