{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "messaging.v2.channels_sender_response": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the sender." }, "status": { "$ref": "#/components/schemas/channels_sender_enum_status" }, "sender_id": { "$ref": "#/components/schemas/messaging.v2.channels_sender.fields.sender_id" }, "configuration": { "$ref": "#/components/schemas/messaging.v2.channels_sender.configuration" }, "webhook": { "$ref": "#/components/schemas/messaging.v2.channels_sender.webhook" }, "profile": { "$ref": "#/components/schemas/messaging.v2.channels_sender.profile_generic_response" }, "properties": { "$ref": "#/components/schemas/messaging.v2.channels_sender.properties" }, "offline_reasons": { "$ref": "#/components/schemas/messaging.v2.channels_sender.offline_reasons" }, "compliance": { "$ref": "#/components/schemas/messaging.v2.rcs_compliance_response" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the resource." } } }, "messaging.v2.rcs_compliance_patch_update_response": { "description": "The KYC compliance information. This section consists of response to the request launch.", "type": "object", "nullable": true, "required": [ "registration_sid" ], "properties": { "registration_sid": { "type": "string", "description": "The default compliance registration SID (e.g., from CR-Google) that applies to all countries unless overridden within the `countries` array.\n" }, "countries": { "type": "array", "description": "A list of country-specific compliance details.\n", "items": { "$ref": "#/components/schemas/messaging.v2.rcs_compliance_country_update_patch_response" } } } }, "messaging.v2.rcs_compliance_response": { "description": "The KYC compliance information. This section consists of response to the request launch.", "type": "object", "nullable": true, "required": [ "registration_sid" ], "properties": { "registration_sid": { "type": "string", "description": "The default compliance registration SID (e.g., from CR-Google) that applies to all countries unless overridden in the `countries` array.\n" }, "countries": { "type": "array", "description": "A list of country-specific compliance details.\n", "items": { "$ref": "#/components/schemas/messaging.v2.rcs_compliance_country_response" } } } }, "messaging.v2.rcs_compliance_country_update_patch_response": { "type": "object", "required": [ "country" ], "properties": { "country": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code.", "example": "US" }, "registration_sid": { "type": "string", "description": "The default compliance registration SID (e.g., from CR-Google) that applies to all countries unless overridden in the `countries` array.\n" }, "status": { "$ref": "#/components/schemas/messaging.v2.rcs_country_status" } } }, "messaging.v2.rcs_compliance_country_response": { "type": "object", "required": [ "country" ], "properties": { "country": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code.", "example": "US" }, "registration_sid": { "type": "string", "description": "The default compliance registration SID (e.g., from CR-Google) that applies to all countries unless overridden in the `countries` array.\n" }, "status": { "$ref": "#/components/schemas/messaging.v2.rcs_country_status" }, "carriers": { "type": "array", "items": { "$ref": "#/components/schemas/messaging.v2.rcs_carrier" } } } }, "messaging.v2.rcs_carrier": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the carrier. For example, `Verizon` or `AT&T` for US." }, "status": { "$ref": "#/components/schemas/messaging.v2.rcs_carrier_status" } } }, "channels_sender_enum_status": { "type": "string", "enum": [ "CREATING", "ONLINE", "OFFLINE", "PENDING_VERIFICATION", "VERIFYING", "ONLINE:UPDATING", "TWILIO_REVIEW", "DRAFT", "STUBBED" ], "description": "The status of the sender.\n" }, "messaging.v2.rcs_country_status": { "type": "string", "description": "The country-level status. Based on the aggregation of the carrier-level status.", "enum": [ "ONLINE", "OFFLINE", "TWILIO_REVIEW", "PENDING_VERIFICATION" ] }, "messaging.v2.rcs_carrier_status": { "type": "string", "description": "The carrier-level status.", "enum": [ "UNKNOWN", "UNLAUNCHED", "CARRIER_REVIEW", "APPROVED", "REJECTED", "SUSPENDED" ] }, "messaging.v2.channels_sender.requests.create": { "type": "object", "required": [ "sender_id" ], "properties": { "sender_id": { "x-field-extra-annotation": "@com.fasterxml.jackson.annotation.JsonProperty(\"sender_id\")", "$ref": "#/components/schemas/messaging.v2.channels_sender.fields.sender_id" }, "configuration": { "$ref": "#/components/schemas/messaging.v2.channels_sender.configuration" }, "webhook": { "$ref": "#/components/schemas/messaging.v2.channels_sender.webhook" }, "profile": { "$ref": "#/components/schemas/messaging.v2.channels_sender.profile" } } }, "messaging.v2.channels_sender.requests.update": { "type": "object", "properties": { "configuration": { "nullable": true, "$ref": "#/components/schemas/messaging.v2.channels_sender.configuration" }, "webhook": { "nullable": true, "$ref": "#/components/schemas/messaging.v2.channels_sender.webhook" }, "profile": { "nullable": true, "$ref": "#/components/schemas/messaging.v2.channels_sender.profile" } } }, "messaging.v2.channels_sender.configuration": { "type": "object", "nullable": true, "properties": { "waba_id": { "type": "string", "description": "The ID of the WhatsApp Business Account (WABA) to use for this sender.", "example": "12345678912345", "nullable": true }, "verification_method": { "type": "string", "enum": [ "sms", "voice" ], "description": "The verification method.", "example": "sms", "default": "sms", "nullable": true }, "verification_code": { "type": "string", "description": "The verification code.", "nullable": true }, "voice_application_sid": { "type": "string", "description": "The SID of the Twilio Voice application.", "nullable": true }, "account_type": { "type": "string", "enum": [ "ISV", "ISVSubAccount" ], "description": "The account type for ISV Account Type Migration. Set to 'ISV' or 'ISVSubAccount' to configure, null or empty string to clear, or omit to preserve the existing value.", "nullable": true } }, "description": "The configuration settings for creating a sender." }, "messaging.v2.channels_sender.webhook": { "type": "object", "nullable": true, "properties": { "callback_url": { "type": "string", "description": "The URL to send the webhook to.", "nullable": true }, "callback_method": { "type": "string", "enum": [ "POST", "PUT" ], "description": "The HTTP method for the webhook.", "nullable": true }, "fallback_url": { "type": "string", "description": "The URL to send the fallback webhook to.", "nullable": true }, "fallback_method": { "type": "string", "enum": [ "POST", "PUT" ], "description": "The HTTP method for the fallback webhook.", "nullable": true }, "status_callback_url": { "type": "string", "description": "The URL to send the status callback to.", "nullable": true }, "status_callback_method": { "type": "string", "description": "The HTTP method for the status callback.", "nullable": true } }, "description": "The configuration settings for webhooks." }, "messaging.v2.whatsapp.typing.indicator": { "type": "object", "description": "- Payload for typing indicator request\n", "properties": { "channel": { "type": "string", "enum": [ "whatsapp" ], "description": "Shared channel identifier", "example": "whatsapp" }, "messageId": { "type": "string", "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "description": "Message SID that identifies the conversation thread for the typing indicator. Must be a valid Twilio Message SID (SM*) or Media SID (MM*) from an existing WhatsApp conversation.\n", "example": "SM1234567890abcdef1234567890abcdef" } }, "required": [ "channel", "messageId" ] }, "messaging.v2.channels_sender.profile": { "type": "object", "nullable": true, "description": "The profile information for the sender.\n", "properties": { "name": { "type": "string", "description": "The name of the sender. Required for WhatsApp senders and must follow [Meta's display name guidelines](https://www.facebook.com/business/help/757569725593362).", "nullable": true }, "about": { "type": "string", "description": "The profile about text for the sender.", "nullable": true }, "address": { "type": "string", "description": "The address of the sender.", "nullable": true }, "description": { "type": "string", "description": "The description of the sender.", "nullable": true }, "logo_url": { "type": "string", "description": "The logo URL of the sender.", "nullable": true }, "banner_url": { "type": "string", "description": "The banner URL of the sender.", "nullable": true }, "privacy_url": { "type": "string", "description": "The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.\n", "nullable": true }, "terms_of_service_url": { "type": "string", "description": "The terms of service URL of the sender.", "nullable": true }, "accent_color": { "type": "string", "description": "The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.", "nullable": true }, "vertical": { "type": "string", "description": "The vertical of the sender. Allowed values are:\n- `Alcohol`\n- `Automotive`\n- `Beauty, Spa and Salon`\n- `Clothing and Apparel`\n- `Education`\n- `Entertainment`\n- `Event Planning and Service`\n- `Finance and Banking`\n- `Food and Grocery`\n- `Hotel and Lodging`\n- `Matrimony Service`\n- `Medical and Health`\n- `Non-profit`\n- `Online Gambling`\n- `OTC Drugs`\n- `Other`\n- `Physical Gambling`\n- `Professional Services`\n- `Public Service`\n- `Restaurant`\n- `Shopping and Retail`\n- `Travel and Transportation`\n", "nullable": true }, "websites": { "description": "The websites of the sender." }, "emails": { "description": "The emails of the sender." }, "phone_numbers": { "description": "The phone numbers of the sender." } } }, "messaging.v2.channels_sender.profile_generic_response": { "type": "object", "nullable": true, "description": "The profile information for the sender.\n", "properties": { "name": { "type": "string", "description": "The name of the sender.", "nullable": true }, "about": { "type": "string", "description": "The profile about text for the sender.", "nullable": true }, "address": { "type": "string", "description": "The address of the sender.", "nullable": true }, "description": { "type": "string", "description": "The description of the sender.", "nullable": true }, "logo_url": { "type": "string", "description": "The logo URL of the sender.", "nullable": true }, "banner_url": { "type": "string", "description": "The banner URL of the sender.", "nullable": true }, "privacy_url": { "type": "string", "description": "The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.", "nullable": true }, "terms_of_service_url": { "type": "string", "description": "The terms of service URL of the sender.", "nullable": true }, "accent_color": { "type": "string", "description": "The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.", "nullable": true }, "vertical": { "type": "string", "description": "The vertical of the sender. Allowed values are:\n- `Alcohol`\n- `Automotive`\n- `Beauty, Spa and Salon`\n- `Clothing and Apparel`\n- `Education`\n- `Entertainment`\n- `Event Planning and Service`\n- `Finance and Banking`\n- `Food and Grocery`\n- `Hotel and Lodging`\n- `Matrimony Service`\n- `Medical and Health`\n- `Non-profit`\n- `Online Gambling`\n- `OTC Drugs`\n- `Other`\n- `Physical Gambling`\n- `Professional Services`\n- `Public Service`\n- `Restaurant`\n- `Shopping and Retail`\n- `Travel and Transportation`\n", "nullable": true }, "websites": { "description": "The websites of the sender.", "nullable": true, "type": "array", "items": { "type": "object", "properties": { "website": { "type": "string" }, "label": { "type": "string" } } } }, "emails": { "description": "The emails of the sender.", "nullable": true, "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "label": { "type": "string" } } } }, "phone_numbers": { "description": "The phone numbers of the sender.", "nullable": true, "type": "array", "items": { "type": "object", "properties": { "phone_number": { "type": "string" }, "label": { "type": "string" } } } } } }, "messaging.v2.channels_sender.properties": { "type": "object", "nullable": true, "properties": { "quality_rating": { "type": "string", "description": "The quality rating of the sender.", "example": "HIGH", "nullable": true }, "messaging_limit": { "type": "string", "description": "The messaging limit of the sender.", "example": "10K Customers/24hr", "nullable": true } }, "description": "The additional properties for the sender." }, "messaging.v2.channels_sender.offline_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/messaging.v2.channels_sender.offline_reasons.items" }, "nullable": true, "description": "The reasons why the sender is offline." }, "messaging.v2.channels_sender.offline_reasons.items": { "type": "object", "nullable": true, "properties": { "code": { "type": "string", "description": "The error code.", "nullable": true }, "message": { "type": "string", "description": "The error message.", "nullable": true }, "more_info": { "type": "string", "format": "uri", "description": "The URL to get more information about the error.", "nullable": true } } }, "messaging.v2.channels_sender.fields.sender_id": { "type": "string", "description": "The ID of the sender in `whatsapp:` format.", "example": "whatsapp:+15017122661", "nullable": true }, "messaging.v2.domain_cert_v4": { "type": "object", "properties": { "domain_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DN[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Domain resource." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "Date that this Domain was last updated." }, "date_expires": { "type": "string", "format": "date-time", "nullable": true, "description": "Date that the private certificate associated with this domain expires. You will need to update the certificate before that date to ensure your shortened links will continue to work." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "Date that this Domain was registered to the Twilio platform to create a new Domain object." }, "domain_name": { "type": "string", "format": "uri", "nullable": true, "description": "Full url path for this domain." }, "certificate_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CW[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify this Certificate resource." }, "managed": { "type": "boolean", "nullable": true, "description": "Boolean field that indicates whether the certificate is managed by Twilio or uploaded by the customer." }, "requesting": { "type": "boolean", "nullable": true, "description": "Boolean field that indicates whether a Twilio managed cert request is in progress or completed. True indicates a request is in progress and false indicates the request has completed or not requested yet." }, "url": { "type": "string", "format": "uri", "nullable": true }, "cert_in_validation": { "nullable": true, "description": "Optional JSON field describing the status and upload date of a new certificate in the process of validation" } } }, "messaging.v2.presigned_url.request": { "type": "object", "properties": { "imageContentMd5": { "type": "string", "description": "Base64-encoded MD5 hash of the image" }, "imageContentType": { "type": "string", "description": "MIME type of the image (e.g., image/png, image/jpeg)" }, "imageKind": { "type": "string", "description": "Type of image (logo, hero, etc.)" }, "imageName": { "type": "string", "description": "Name of the image file" }, "imageSizeBytes": { "type": "integer", "description": "Size of the image in bytes" }, "imageHeight": { "type": "integer", "description": "Height of the image in pixels" }, "imageWidth": { "type": "integer", "description": "Width of the image in pixels" } }, "required": [ "imageContentMd5", "imageContentType", "imageKind", "imageName", "imageSizeBytes" ] }, "messaging.v2.presigned_url.response": { "type": "object", "properties": { "expiresAt": { "type": "string", "format": "date-time" }, "fetchUrl": { "type": "string" }, "uploadUrl": { "type": "string" }, "uploadFields": { "type": "object" } } } }, "examples": { "whatsapp_create_request": { "value": { "sender_id": "whatsapp:+999999999XX", "configuration": { "waba_id": "1234567XXX", "verification_method": "sms" }, "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "name": "Example Profile Name", "about": "This is an example about text.", "address": "123 Example St, Example City, EX 12345", "description": "This is an example description.", "emails": [ { "email": "example1@example.com", "label": "Email" }, { "email": "example2@example.com", "label": "Email" } ], "logo_url": "https://logo_url.example.com", "vertical": "Automotive", "websites": [ { "website": "https://website1.example.com", "label": "Website1" }, { "website": "http://website2.example.com", "label": "Website2" } ] } } }, "whatsapp_create_response": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "CREATING", "sender_id": "whatsapp:+999999999XX", "configuration": { "waba_id": "1234567XXX", "verification_method": "sms", "verification_code": null, "voice_application_sid": "APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "account_type": null }, "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "name": "Example Profile Name", "about": "This is an example about text.", "address": "123 Example St, Example City, EX 12345", "description": "This is an example description.", "emails": [ { "email": "example@example.com", "label": "Email" }, { "email": "example2@example.com", "label": "Email" } ], "logo_url": "https://logo_url.example.com", "vertical": "Automotive", "websites": [ { "website": "https://website1.example.com", "label": "Website1" }, { "website": "http://website2.example.com", "label": "Website2" } ] } } }, "rcs_create_request": { "value": { "sender_id": "rcs:twilio_agent", "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "name": "RCS Profile Name", "description": "RCS description.", "accent_color": "#ffffff", "logo_url": "https://logo_url.example.com", "banner_url": "https://banner_url.example.com", "privacy_url": "https://privacy_url.example.com", "terms_of_service_url": "https://terms_of_service_url.example.com", "phone_numbers": [ { "phone_number": "+12125551212", "label": "phone" } ], "websites": [ { "website": "https://website1.example.com", "label": "Website1" }, { "website": "http://website2.example.com", "label": "Website2" } ], "emails": [ { "email": "example1@example.com", "label": "example1" }, { "email": "example2@example.com", "label": "example2" } ] } } }, "rcs_create_response": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "CREATING", "sender_id": "rcs:twilio_agent", "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "name": "RCS Profile Name", "description": "RCS description.", "accent_color": "#ffffff", "logo_url": "https://logo_url.com", "banner_url": "https://banner_url.com", "privacy_url": "https://privacy_url.com", "terms_of_service_url": "https://terms_of_service_url.com", "phone_numbers": [ { "phone_number": "+12125551212", "label": "phone" } ], "websites": [ { "website": "https://website1.com", "label": "Website1" }, { "website": "http://website2.com", "label": "Website2" } ], "emails": [ { "email": "example1@example.com", "label": "example1" }, { "email": "example2@example.com", "label": "example2" } ] }, "compliance": { "registration_sid": "", "countries": [] } } }, "whatsapp_fetch": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "ONLINE", "sender_id": "whatsapp:+999999999XX", "configuration": { "waba_id": "1234567XXX", "verification_method": null, "verification_code": null, "voice_application_sid": "APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "account_type": null }, "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "name": "Example Profile Name", "about": "This is an example about text.", "address": "123 Example St, Example City, EX 12345", "description": "This is an example description.", "emails": [ { "email": "email@email.com", "label": "Email" } ], "logo_url": "https://logo_url.example.com", "vertical": "Automotive", "websites": [ { "website": "https://website1.example.com", "label": "Website" }, { "website": "http://website2.example.com", "label": "Website" } ], "banner_url": null, "privacy_url": null, "terms_of_service_url": null, "accent_color": null, "phone_numbers": null }, "compliance": null, "properties": { "quality_rating": "HIGH", "messaging_limit": "10K Customers/24hr" }, "offline_reasons": null, "url": "https://messaging.twilio.com/v2/Channels/Senders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } }, "whatsapp_fetch_offline_reasons": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "OFFLINE", "sender_id": "whatsapp:+999999999XX", "configuration": { "waba_id": "1234567XXX", "verification_method": null, "verification_code": null, "voice_application_sid": "APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "account_type": null }, "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "name": "Example Profile Name", "about": "This is an example about text.", "address": "123 Example St, Example City, EX 12345", "description": "This is an example description.", "emails": [ { "email": "email@email.com", "label": "Email" } ], "logo_url": "https://logo_url.com", "vertical": "Automotive", "websites": [ { "website": "https://website1.example.com", "label": "Website" }, { "website": "http://website2.example.com", "label": "Website" } ], "banner_url": null, "privacy_url": null, "terms_of_service_url": null, "accent_color": null, "phone_numbers": null }, "compliance": null, "properties": { "quality_rating": "HIGH", "messaging_limit": "10K Customers/24hr" }, "offline_reasons": [ { "code": "30008", "message": "No delivery", "more_info": "https://www.twilio.com/docs/api/errors/30008" } ], "url": "https://messaging.twilio.com/v2/Channels/Senders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } }, "rcs_fetch": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "PENDING_VERIFICATION", "sender_id": "rcs:twilio_agent", "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "name": "RCS Profile Name", "description": "RCS description.", "accent_color": "#ffffff", "logo_url": "https://logo_url.example.com", "banner_url": "https://banner_url.example.com", "privacy_url": "https://privacy_url.example.com", "terms_of_service_url": "https://terms_of_service_url.example.com", "phone_numbers": [ { "phone_number": "+12125551212", "label": "phone" } ], "websites": [ { "website": "https://website1.example.com", "label": "Website1" }, { "website": "http://website2.example.com", "label": "Website2" } ], "emails": [ { "email": "example1@example.com", "label": "example1" }, { "email": "example2@example.com", "label": "example2" } ], "about": null, "address": null, "vertical": null }, "compliance": { "registration_sid": "BUxxx", "countries": [ { "registration_sid": "BUyyy", "country": "US", "status": "PENDING_VERIFICATION", "carriers": [ { "name": "Verizon", "status": "CARRIER_REVIEW" } ] }, { "registration_sid": "BUxx", "country": "UK", "status": "PENDING_VERIFICATION", "carriers": [ { "name": "OS", "status": "CARRIER_REVIEW" } ] } ] } } }, "create_test_device_request": { "value": { "phone_number": "+14081111111" } }, "test_device_response": { "value": { "phone_number": "+14081111111", "status": "PENDING" } }, "list_test_devices_response": { "value": { "phone_numbers": [ { "phone_number": "+14081111111", "status": "ACCEPTED" }, { "phone_number": "+14082222222", "status": "PENDING" } ], "meta": { "page": 0, "page_size": 10, "first_page_url": "https://messaging.twilio.com/v2/Channels/Senders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestDevices?PageSize=10&Page=0", "previous_page_url": null, "url": "https://messaging.twilio.com/v2/Channels/Senders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestDevices?PageSize=10&Page=0", "next_page_url": null, "key": "test_devices" } } }, "whatsapp_patch_update_configuration_request": { "value": { "configuration": { "verification_code": "123456", "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_type": null } } }, "whatsapp_patch_update_webhook_request": { "value": { "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" } } }, "whatsapp_patch_update_profile_request": { "value": { "profile": { "name": "Example Business", "about": "Example about text", "address": "123 Example St, Example City, EX 12345", "description": "Example description", "logo_url": "https://logo_url.example.com", "vertical": "Automotive", "websites": [ { "website": "https://website3.example.com", "label": "Website3" }, { "website": "http://website4.example.com", "label": "Website4" } ], "emails": [ { "email": "email@email.com", "label": "Email" } ] } } }, "rcs_patch_update_webhook_request": { "value": { "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" } } }, "rcs_patch_update_profile_request": { "value": { "profile": { "name": "RCS Profile Name", "description": "RCS description.", "accent_color": "#ffffff", "logo_url": "https://logo_url.example.com", "banner_url": "https://banner_url.example.com", "privacy_url": "https://privacy_url.example.com", "terms_of_service_url": "https://terms_of_service_url.example.com", "phone_numbers": [ { "phone_number": "+12125551212", "label": "phone" } ], "websites": [ { "website": "https://website3.example.com", "label": "Website3" }, { "website": "http://website4.example.com", "label": "Website4" } ], "emails": [ { "email": "example1@example.com", "label": "example1" }, { "email": "example2@example.com", "label": "example2" } ] } } }, "rcs_patch_update_compliance_request": { "value": { "compliance": { "registration_sid": "BUxx", "countries": [ { "country": "US", "registration_sid": "BUyyy" }, { "country": "UK" } ] } } }, "rcs_patch_update_webhook_response": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "DRAFT", "sender_id": "rcs:test_agent", "compliance": null, "configuration": null, "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": null } }, "whatsapp_patch_update_configuration_response": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "VERIFYING", "sender_id": "whatsapp:+999999999XX", "compliance": null, "webhook": null, "profile": null, "configuration": { "verification_code": "123456", "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_type": null } } }, "whatsapp_patch_update_profile_response": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "VERIFYING", "sender_id": "whatsapp:+999999999XX", "compliance": null, "configuration": null, "webhook": null, "profile": { "about": "Example about text", "address": "123 Example St, Example City, EX 12345", "description": "Example description", "emails": [ { "email": "email@email.com", "label": "Email" } ], "name": "Example Business", "logo_url": "https://logo_url.example.com", "vertical": "Automotive", "websites": [ { "website": "https://website3.example.com", "label": "Website3" }, { "website": "http://website4.example.com", "label": "Website4" } ], "banner_url": null, "privacy_url": null, "terms_of_service_url": null, "accent_color": null, "phone_numbers": null } } }, "whatsapp_patch_update_webhook_response": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "VERIFYING", "sender_id": "whatsapp:+999999999XX", "compliance": null, "configuration": null, "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": null } }, "rcs_patch_update_compliance_response": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "DRAFT", "sender_id": "rcs:test_agent", "compliance": { "registration_sid": "BUxxx", "countries": [ { "country": "US", "registration_sid": "BUyyy", "status": "PENDING_VERIFICATION" }, { "country": "UK", "registration_sid": "BUxxx", "status": "PENDING_VERIFICATION" } ] }, "configuration": null, "webhook": null, "profile": null } }, "rcs_patch_update_profile_response": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "DRAFT", "sender_id": "rcs:test_agent", "compliance": null, "webhook": null, "profile": { "name": "RCS Profile Name", "description": "RCS description.", "accent_color": "#ffffff", "logo_url": "https://logo_url.com", "banner_url": "https://banner_url.com", "privacy_url": "https://privacy_url.com", "terms_of_service_url": "https://terms_of_service_url.com", "phone_numbers": [ { "phone_number": "+12125551212", "label": "phone" } ], "websites": [ { "website": "https://website3.example.com", "label": "Website3" }, { "website": "http://website4.example.com", "label": "Website4" } ], "emails": [ { "email": "example1@example.com", "label": "example1" }, { "email": "example2@example.com", "label": "example2" } ], "about": null, "address": null, "vertical": null }, "configuration": null } } } }, "info": { "title": "Twilio - Messaging", "description": "This is the public Twilio REST API.", "termsOfService": "https://www.twilio.com/legal/tos", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0", "x-twilio": { "apiStandards": "v0.1" } }, "openapi": "3.0.1", "paths": { "/v2/Indicators/Typing.json": { "servers": [ { "url": "https://messaging.twilio.com" } ], "description": "Send a typing indicator event between OTT senders (e.g., WhatsApp, RCS).", "x-twilio": { "defaultOutputProperties": [ "success" ], "mountName": "typing_indicator", "pathType": "list" }, "post": { "summary": "Send a typing indicator", "description": "Send a typing indicator to notify the recipient that you are composing a message. Currently supported for whatsapp channel only. For WhatsApp, `messageId` is required.\n", "tags": [ "MessagingV2TypingIndicator" ], "operationId": "CreateTypingIndicator", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/messaging.v2.whatsapp.typing.indicator" }, "examples": { "whatsapp_typing_indicator": { "summary": "WhatsApp Typing Indicator", "description": "Send a typing indicator for an active WhatsApp conversation", "value": { "channel": "whatsapp", "messageId": "SM1234567890abcdef1234567890abcdef" } } } } } }, "responses": { "200": { "description": "Typing indicator was successfully sent to the recipient.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the typing indicator was sent successfully.", "example": true } } }, "examples": { "success": { "value": { "success": true } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } }, "security": [ { "accountSid_authToken": [] } ] } }, "/v2/Channels/Senders": { "servers": [ { "url": "https://messaging.twilio.com" } ], "description": "The Senders resource represents a messaging channel sender (WhatsApp, RCS).", "x-twilio": { "defaultOutputProperties": [ "sid", "status", "sender_id" ], "mountName": "channels_senders", "pathType": "list" }, "post": { "description": "Create a Sender.", "summary": "Create a Sender", "tags": [ "MessagingV2ChannelsSender" ], "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateChannelsSender", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v2.channels_sender.requests.create" }, "examples": { "whatsapp_create": { "$ref": "#/components/examples/whatsapp_create_request" }, "rcs_create": { "$ref": "#/components/examples/rcs_create_request" } } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v2.channels_sender_response" }, "examples": { "whatsapp_create": { "$ref": "#/components/examples/whatsapp_create_response" }, "rcs_create": { "$ref": "#/components/examples/rcs_create_response" } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } }, "T-Request-Id": { "schema": { "type": "string" } } }, "description": "Accepted" } } }, "get": { "description": "Retrieve a list of Senders for an account.", "summary": "Retrieve a list of Senders", "tags": [ "MessagingV2ChannelsSender" ], "parameters": [ { "name": "Channel", "required": true, "in": "query", "schema": { "type": "string", "description": "The messaging channel for senders. Supported values are `whatsapp` and `rcs`." } }, { "name": "PageSize", "in": "query", "description": "The number of items to return per page. For WhatsApp, the default is `20`.", "schema": { "type": "integer", "format": "int64", "default": 50, "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. Use only for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "senders": { "type": "array", "items": { "$ref": "#/components/schemas/messaging.v2.channels_sender_response" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListChannelsSenderResponse" }, "examples": { "readEmpty": { "value": { "senders": [], "meta": { "page": 0, "page_size": 10, "first_page_url": "https://messaging.twilio.com/v2/Channels/Senders?PageSize=10&Page=0&Channel=whatsapp", "previous_page_url": null, "url": "https://messaging.twilio.com/v2/Channels/Senders?PageSize=10&Page=0&Channel=whatsapp", "next_page_url": null, "key": "senders" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } }, "T-Request-Id": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListChannelsSender" } }, "/v2/Channels/Senders/{Sid}": { "servers": [ { "url": "https://messaging.twilio.com" } ], "description": "The Senders resource represents a messaging channel sender.", "x-twilio": { "defaultOutputProperties": [ "sid", "status", "sender_id" ], "mountName": "channels_senders", "pathType": "instance" }, "get": { "description": "Retrieve a Sender.", "summary": "Retrieve a Sender", "tags": [ "MessagingV2ChannelsSender" ], "parameters": [ { "name": "Sid", "required": true, "in": "path", "description": "The SID of the sender.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v2.channels_sender_response" }, "examples": { "whatsapp_fetch": { "$ref": "#/components/examples/whatsapp_fetch" }, "whatsapp_fetch_offline_reasons": { "$ref": "#/components/examples/whatsapp_fetch_offline_reasons" }, "rcs_fetch": { "$ref": "#/components/examples/rcs_fetch" } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } }, "T-Request-Id": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchChannelsSender" }, "post": { "description": "(WhatsApp only) Update a Sender. You can update a sender's information, including `profile`, `webhook`, and `configuration`. To verify a phone number, set `configuration.verification_code` to the One-time Password (OTP) that you received.", "summary": "Update a sender's information, including `profile`, `webhook`, and `configuration`.", "tags": [ "MessagingV2ChannelsSender" ], "parameters": [ { "name": "Sid", "required": true, "in": "path", "description": "The SID of the sender.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v2.channels_sender_response" }, "examples": { "update": { "value": { "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "VERIFYING", "sender_id": "whatsapp:+999999999XX", "compliance": null, "configuration": { "waba_id": "1234567XXX", "verification_method": "sms", "verification_code": null, "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_type": null }, "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "about": "Example about text", "address": "123 Example St, Example City, EX 12345", "description": "Example description", "emails": [ { "email": "email@email.com", "label": "Email" } ], "name": "Example Business", "logo_url": "https://logo_url.example.com", "vertical": "Automotive", "websites": [ { "website": "https://website1.example.com", "label": "Website" }, { "website": "http://website2.example.com", "label": "Website" } ], "banner_url": null, "privacy_url": null, "terms_of_service_url": null, "accent_color": null, "phone_numbers": null } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } }, "T-Request-Id": { "schema": { "type": "string" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateChannelsSender", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v2.channels_sender.requests.update" }, "examples": { "update": { "value": { "configuration": { "verification_code": "123456", "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "webhook": { "callback_url": "https://callback.example.com", "callback_method": "POST", "fallback_url": "https://fallback.example.com", "fallback_method": "POST", "status_callback_url": "https://statuscallback.example.com", "status_callback_method": "POST" }, "profile": { "name": "Example Business", "about": "Example about text", "address": "123 Example St, Example City, EX 12345", "description": "Example description", "logo_url": "https://logo_url.example.com", "vertical": "Automotive", "websites": [ { "website": "https://website1.example.com", "label": "Website" }, { "website": "http://website2.example.com", "label": "Website" } ], "emails": [ { "email": "email@email.com", "label": "Email" } ] } } } } } } } }, "delete": { "description": "(WhatsApp only) Delete a Sender.", "summary": "Delete a Sender", "tags": [ "MessagingV2ChannelsSender" ], "parameters": [ { "name": "Sid", "required": true, "in": "path", "description": "The SID of the sender.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^XE[0-9a-fA-F]{32}$" } } ], "responses": { "204": { "description": "The resource was deleted successfully.", "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } }, "T-Request-Id": { "schema": { "type": "string" } } } } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteChannelsSender" } }, "/v2/LinkShortening/Domains/{DomainSid}/Certificate": { "servers": [ { "url": "https://messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "certificate_sid", "domain_name", "domain_sid", "date_expires", "date_created", "date_updated", "url" ], "mountName": "domain_certs", "className": "domain_certs", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "MessagingV2DomainCerts" ], "parameters": [ { "name": "DomainSid", "in": "path", "description": "Unique string used to identify the domain that this certificate should be associated with.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^DN[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v2.domain_cert_v4" }, "examples": { "fetch": { "value": { "certificate_sid": "CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "domain_name": "https://api.example.com", "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_expires": "2021-02-06T18:02:04Z", "date_created": "2021-02-06T18:02:04Z", "date_updated": "2021-02-06T18:02:04Z", "url": "https://messaging.twilio.com/v2/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate", "cert_in_validation": { "date_expires": "2021-02-06T18:02:04Z", "status": "pending" }, "managed": false, "requesting": false } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDomainCertV4" } } }, "servers": [ { "url": "https://messaging.twilio.com" } ], "tags": [ { "name": "MessagingV2ChannelsSender" }, { "name": "MessagingV2Version" }, { "name": "MessagingV2TypingIndicator" } ], "security": [ { "accountSid_authToken": [] } ] }