Type Alias ServerStatusPayload

Type Declaration

• Optionalbiz_opaque_callback_data?: string

  Only included if message sent with biz_opaque_callback_data

• id: string

  The message's ids

• Optionalinternal_1p_only_data?: { webhook_extra_data: string }

  Internal undocumented property

• Optionalrecipient_id?: string

  Will be set to the user’s phone number, if you sent the message to the user’s phone number. Will be set to the group ID, if you sent the message to a group. Will be omitted if you sent the message to the user’s BSUID or parent BSUID.

• Optionalrecipient_identity_key_hash?: string

  Only included if identity change check enabled

  See

  https://developers.facebook.com/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers

• Optionalrecipient_logical_id?: string

  Undocumented on the docs, but exists on the payloads

• Optionalrecipient_parent_user_id?: string

  Will be set to the user’s parent BSUID if you have enabled parent BSUIDs

  See

  https://developers.facebook.com/documentation/business-messaging/whatsapp/business-scoped-user-ids#parent-business-scoped-user-ids

• Optionalrecipient_participant_id?: string

  WhatsApp user phone number. Only included if message sent to a group.

• Optionalrecipient_type?: "individual" | "group"

  If the recipient is a user or a group, defaults to "individual"

• Optionalrecipient_user_id?: string

  Will always be set to the user’s BSUID, regardless of whether the message was sent to the user’s phone number or BSUID. For failed status messages, will be omitted if the message was sent to the user’s phone number.

• status: ServerStatus

  The message's status

• timestamp: string

  The message's timestamp

• {
      recipient_id?: string;
      recipient_participant_id?: undefined;
      recipient_type?: "individual";
  }
• {
      recipient_id: string;
      recipient_participant_id: string;
      recipient_type: "group";
  }

• {
      conversation?: ServerConversation;
      errors?: undefined;
      pricing?: ServerPricing;
  }
• { conversation: undefined; errors: [ServerError]; pricing: undefined }