WhatsApp Integration

Fetch a whatsappIntegration

get/integration/whatsapp/{whatsappIntegrationId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/whatsapp/{whatsappIntegrationId}/fetch
  • Auth: HTTP bearer

Path parameters

whatsappIntegrationIdstring required

The ID of the WhatsApp integration to retrieve

Response

The WhatsApp integration was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

botIdstring nullable

The ID of the bot this configuration is using

blueprintIdstring nullable

The ID of the blueprint

verifyTokenstring required

The WhatsApp integration verify token

phoneNumberIdstring nullable

The WhatsApp integration phone number ID

accessTokenstring nullable

The WhatsApp integration access token (returned as '********' if configured, null otherwise)

appSecretstring nullable

The Meta app secret (returned as '********' if configured, null otherwise)

contactCollectionboolean

Weather to collect contacts

sessionDurationnumber nullable

The session duration (in milliseconds)

attachmentsboolean

Weather the bot supports attachments

allowFromstring nullable

Newline-or-comma-separated list of allowed senders

Changes

No recorded changes to this operation across all 1 revision of this API.