Skip to content

Whatsapp Messages

POST /{partner_id}/integrations/{integration_id}/whatsapp-messages

Section titled “POST /{partner_id}/integrations/{integration_id}/whatsapp-messages”

New Whatsapp Message

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"security":[{"APIKeyHeader":[]}],"components":{"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"apikey"}},"schemas":{"CreateWhatsappMessageRequest":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"destination_phone":{"type":"string","pattern":"^\\+\\d{5,15}$","title":"Destination Phone","description":"Phone number in E164 format"},"message_type":{"type":"string","enum":["booking_created","booking_cancelled","booking_updated"],"title":"Message Type"},"booking_data":{"additionalProperties":true,"type":"object","title":"Booking Data"}},"type":"object","required":["customer_id","destination_phone","message_type","booking_data"],"title":"CreateWhatsappMessageRequest"},"NewMessageResponse":{"properties":{"message_id":{"type":"string","title":"Message Id"}},"type":"object","required":["message_id"],"title":"NewMessageResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/{partner_id}/integrations/{integration_id}/whatsapp-messages":{"post":{"tags":["Whatsapp Messages"],"summary":"New Whatsapp Message","operationId":"new_whatsapp_message__partner_id__integrations__integration_id__whatsapp_messages_post","parameters":[{"name":"partner_id","in":"path","required":true,"schema":{"type":"string","title":"Partner Id"}},{"name":"integration_id","in":"path","required":true,"schema":{"type":"string","title":"Integration Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWhatsappMessageRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}

GET /{partner_id}/integrations/{integration_id}/whatsapp-messages/{message_id}

Section titled “GET /{partner_id}/integrations/{integration_id}/whatsapp-messages/{message_id}”

Whatsapp Message Data

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"security":[{"APIKeyHeader":[]}],"components":{"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"apikey"}},"schemas":{"MessageDataResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/WhatsAppMessageStatus"},"created":{"type":"string","format":"date-time","title":"Created"}},"type":"object","required":["id","status","created"],"title":"MessageDataResponse"},"WhatsAppMessageStatus":{"type":"string","enum":["deleted","delivered","failed","read","sent","warning","created"],"title":"WhatsAppMessageStatus","description":"Delivery status of a WhatsApp message.\n\n`CREATED` has been added by us to mark locally-created messages with no\nfeedback status from WhatsApp yet."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/{partner_id}/integrations/{integration_id}/whatsapp-messages/{message_id}":{"get":{"tags":["Whatsapp Messages"],"summary":"Whatsapp Message Data","operationId":"whatsapp_message_data__partner_id__integrations__integration_id__whatsapp_messages__message_id__get","parameters":[{"name":"partner_id","in":"path","required":true,"schema":{"type":"string","title":"Partner Id"}},{"name":"integration_id","in":"path","required":true,"schema":{"type":"string","title":"Integration Id"}},{"name":"message_id","in":"path","required":true,"schema":{"type":"string","title":"Message Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageDataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}