/twilio-messaging | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
twilio_messaging_create_message | Send a message |
twilio_messaging_delete_media | Delete the Media resource. |
twilio_messaging_delete_message | Deletes a Message resource from your account |
twilio_messaging_fetch_media | Fetch a single Media resource associated with a specific Message resource |
twilio_messaging_fetch_message | Fetch a specific Message |
twilio_messaging_fetch_short_code | Fetch an instance of a short code |
twilio_messaging_list_media | Read a list of Media resources associated with a specific Message resource |
twilio_messaging_list_message | Retrieve a list of Message resources associated with a Twilio Account |
twilio_messaging_list_short_code | Retrieve a list of short-codes belonging to the account used to make the request |
twilio_messaging_update_message | Update a Message resource (used to redact Message body text and to cancel not-yet-sent messages) |
twilio_messaging_update_short_code | Update a short code with the following parameters |
twilio_messaging_create_message
Send a message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AddressRetention | string | No | — | Determines if the address can be stored or obfuscated based on privacy settings |
ApplicationSid | string | No | — | The SID of the associated TwiML Application. Message status callback requests are sent to the TwiML App’s message_status_callback URL. Note that the status_callback parameter of a request takes priority over the application_sid parameter; if both are included application_sid is ignored. |
Attempt | integer | No | — | Total number of attempts made (including this request) to send the message regardless of the provider used |
Body | string | No | — | The text content of the outgoing message. Can be up to 1,600 characters in length. SMS only: If the body contains more than 160 GSM-7 characters (or 70 UCS-2 characters), the message is segmented and charged accordingly. For long body text, consider using the send_as_mms parameter. |
ContentRetention | string | No | — | Determines if the message content can be stored or redacted based on privacy settings |
ContentSid | string | No | — | For Content Editor/API only: The SID of the Content Template to be used with the Message, e.g., HXXXXXXXXXXXXXXXXXXXXXXXXXXXXX. If this parameter is not provided, a Content Template is not used. Find the SID in the Console on the Content Editor page. For Content API users, the SID is found in Twilio’s response when creating the Template or by fetching your Templates. |
ContentVariables | string | No | — | For Content Editor/API only: Key-value pairs of Template variables and their substitution values. content_sid parameter must also be provided. If values are not defined in the content_variables parameter, the Template’s default placeholder values are used. |
FallbackFrom | string | No | — | A fallback SMS sender to use when the recipient cannot be reached over RCS. This parameter may only be used when also providing a Messaging Service containing an RCS sender. The fallback SMS sender must be either a Twilio phone number (in E.164 format), alphanumeric sender ID, or short code, hosted within Twilio and belong to the Account creating the Message. |
ForceDelivery | boolean | No | — | Reserved |
From | string | No | — | The sender’s Twilio phone number (in E.164 format), alphanumeric sender ID, Wireless SIM, short code, or channel address (e.g., whatsapp:+15554449999). The value of the from parameter must be a sender that is hosted within Twilio and belongs to the Account creating the Message. If you are using messaging_service_sid, this parameter can be empty (Twilio assigns a from value from the Messaging Service’s Sender Pool) or you can provide a specific sender from your Sender Pool. |
MaxPrice | number | No | — | [OBSOLETE] This parameter will no longer have any effect as of 2024-06-03. |
MediaUrl | string[] | No | — | The URL of media to include in the Message content. jpeg, jpg, gif, and png file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (jpeg, jpg, png, gif) and 500 KB for other types of accepted media. To send more than one image in the message, provide multiple media_url parameters in the POST request. You can include up to ten media_url parameters per message. International and carrier limits apply. |
MessagingServiceSid | string | No | — | The SID of the Messaging Service you want to associate with the Message. When this parameter is provided and the from parameter is omitted, Twilio selects the optimal sender from the Messaging Service’s Sender Pool. You may also provide a from parameter if you want to use a specific Sender from the Sender Pool. |
PersistentAction | string[] | No | — | Rich actions for non-SMS/MMS channels. Used for sending location in WhatsApp messages. |
ProvideFeedback | boolean | No | — | Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the Message Feedback subresource). Default value is false. |
RiskCheck | string | No | — | Include this parameter with a value of disable to skip any kind of risk check on the respective message request. |
ScheduleType | string | No | — | For Messaging Services only: Include this parameter with a value of fixed in conjuction with the send_time parameter in order to schedule a Message. |
SendAsMms | boolean | No | — | If set to true, Twilio delivers the message as a single MMS message, regardless of the presence of media. |
SendAt | string | No | — | The time that Twilio will send the message. Must be in ISO 8601 format. |
ShortenUrls | boolean | No | — | For Messaging Services with Link Shortening configured only: A Boolean indicating whether or not Twilio should shorten links in the body of the Message. Default value is false. If true, the messaging_service_sid parameter must also be provided. |
SmartEncoded | boolean | No | — | Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: true or false. |
StatusCallback | string | No | — | The URL of the endpoint to which Twilio sends Message status callback requests. URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the messaging_service_sid, Twilio uses this URL instead of the Status Callback URL of the Messaging Service. |
To | string | Yes | — | The recipient’s phone number in E.164 format (for SMS/MMS) or channel address, e.g. whatsapp:+15552229999. |
TrafficType | string | No | — | Traffic Type |
ValidityPeriod | integer | No | — | The maximum length in seconds that the Message can remain in Twilio’s outgoing message queue. If a queued Message exceeds the validity_period, the Message is not sent. Accepted values are integers from 1 to 36000. Default value is 36000. A validity_period greater than 5 is recommended. Learn more about the validity period |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"AddressRetention": {
"type": "string",
"description": "Determines if the address can be stored or obfuscated based on privacy settings",
"enum": [
"retain",
"obfuscate"
]
},
"ApplicationSid": {
"type": "string",
"description": "The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL. Note that the `status_callback` parameter of a request takes priority over the `application_sid` parameter; if both are included `application_sid` is ignored."
},
"Attempt": {
"type": "integer",
"description": "Total number of attempts made (including this request) to send the message regardless of the provider used"
},
"Body": {
"type": "string",
"description": "The text content of the outgoing message. Can be up to 1,600 characters in length. SMS only: If the `body` contains more than 160 [GSM-7](https://www.twilio.com/docs/glossary/what-is-gsm-7-character-encoding) characters (or 70 [UCS-2](https://www.twilio.com/docs/glossary/what-is-ucs-2-character-encoding) characters), the message is segmented and charged accordingly. For long `body` text, consider using the [send_as_mms parameter](https://www.twilio.com/blog/mms-for-long-text-messages)."
},
"ContentRetention": {
"type": "string",
"description": "Determines if the message content can be stored or redacted based on privacy settings",
"enum": [
"retain",
"discard"
]
},
"ContentSid": {
"type": "string",
"description": "For [Content Editor/API](https://www.twilio.com/docs/content) only: The SID of the Content Template to be used with the Message, e.g., `HXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`. If this parameter is not provided, a Content Template is not used. Find the SID in the Console on the Content Editor page. For Content API users, the SID is found in Twilio's response when [creating the Template](https://www.twilio.com/docs/content/content-api-resources#create-templates) or by [fetching your Templates](https://www.twilio.com/docs/content/content-api-resources#fetch-all-content-resources)."
},
"ContentVariables": {
"type": "string",
"description": "For [Content Editor/API](https://www.twilio.com/docs/content) only: Key-value pairs of [Template variables](https://www.twilio.com/docs/content/using-variables-with-content-api) and their substitution values. `content_sid` parameter must also be provided. If values are not defined in the `content_variables` parameter, the [Template's default placeholder values](https://www.twilio.com/docs/content/content-api-resources#create-templates) are used."
},
"FallbackFrom": {
"type": "string",
"description": "A fallback SMS sender to use when the recipient cannot be reached over RCS. This parameter may only be used when also providing a [Messaging Service](https://twilio.com/docs/messaging/services) containing an RCS sender. The fallback SMS sender must be either a Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), or [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), hosted within Twilio and belong to the Account creating the Message."
},
"ForceDelivery": {
"type": "boolean",
"description": "Reserved"
},
"From": {
"type": "string",
"description": "The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belongs to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service's Sender Pool) or you can provide a specific sender from your Sender Pool."
},
"MaxPrice": {
"type": "number",
"description": "[OBSOLETE] This parameter will no longer have any effect as of 2024-06-03."
},
"MediaUrl": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"description": "The URL of media to include in the Message content. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/messaging/guides/accepted-mime-types) of accepted media. To send more than one image in the message, provide multiple `media_url` parameters in the POST request. You can include up to ten `media_url` parameters per message. [International](https://support.twilio.com/hc/en-us/articles/223179808-Sending-and-receiving-MMS-messages) and [carrier](https://support.twilio.com/hc/en-us/articles/223133707-Is-MMS-supported-for-all-carriers-in-US-and-Canada-) limits apply."
},
"MessagingServiceSid": {
"type": "string",
"description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) you want to associate with the Message. When this parameter is provided and the `from` parameter is omitted, Twilio selects the optimal sender from the Messaging Service's Sender Pool. You may also provide a `from` parameter if you want to use a specific Sender from the Sender Pool."
},
"PersistentAction": {
"type": "array",
"items": {
"type": "string"
},
"description": "Rich actions for non-SMS/MMS channels. Used for [sending location in WhatsApp messages](https://www.twilio.com/docs/whatsapp/message-features#location-messages-with-whatsapp)."
},
"ProvideFeedback": {
"type": "boolean",
"description": "Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the [Message Feedback subresource](https://www.twilio.com/docs/sms/api/message-feedback-resource)). Default value is `false`."
},
"RiskCheck": {
"type": "string",
"description": "Include this parameter with a value of `disable` to skip any kind of risk check on the respective message request.",
"enum": [
"enable",
"disable"
]
},
"ScheduleType": {
"type": "string",
"description": "For Messaging Services only: Include this parameter with a value of `fixed` in conjuction with the `send_time` parameter in order to [schedule a Message](https://www.twilio.com/docs/messaging/features/message-scheduling).",
"enum": [
"fixed"
]
},
"SendAsMms": {
"type": "boolean",
"description": "If set to `true`, Twilio delivers the message as a single MMS message, regardless of the presence of media."
},
"SendAt": {
"type": "string",
"description": "The time that Twilio will send the message. Must be in ISO 8601 format."
},
"ShortenUrls": {
"type": "boolean",
"description": "For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/link-shortening) only: A Boolean indicating whether or not Twilio should shorten links in the `body` of the Message. Default value is `false`. If `true`, the `messaging_service_sid` parameter must also be provided."
},
"SmartEncoded": {
"type": "boolean",
"description": "Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: `true` or `false`."
},
"StatusCallback": {
"type": "string",
"description": "The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource)."
},
"To": {
"type": "string",
"description": "The recipient's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/messaging/channels), e.g. `whatsapp:+15552229999`."
},
"TrafficType": {
"type": "string",
"description": "Traffic Type",
"enum": [
"free"
]
},
"ValidityPeriod": {
"type": "integer",
"description": "The maximum length in seconds that the Message can remain in Twilio's outgoing message queue. If a queued Message exceeds the `validity_period`, the Message is not sent. Accepted values are integers from `1` to `36000`. Default value is `36000`. A `validity_period` greater than `5` is recommended. [Learn more about the validity period](https://www.twilio.com/blog/take-more-control-of-outbound-messages-using-validity-period-html)"
}
},
"required": [
"PCID",
"To"
]
}
twilio_messaging_delete_media
Delete the Media resource. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
MessageSid | string | Yes | — | The SID of the Message resource that is associated with the Media resource. |
Sid | string | Yes | — | The unique identifier of the to-be-deleted Media resource. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"MessageSid": {
"type": "string",
"description": "The SID of the Message resource that is associated with the Media resource."
},
"Sid": {
"type": "string",
"description": "The unique identifier of the to-be-deleted Media resource."
}
},
"required": [
"PCID",
"MessageSid",
"Sid"
]
}
twilio_messaging_delete_message
Deletes a Message resource from your account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Sid | string | Yes | — | The SID of the Message resource you wish to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Sid": {
"type": "string",
"description": "The SID of the Message resource you wish to delete"
}
},
"required": [
"PCID",
"Sid"
]
}
twilio_messaging_fetch_media
Fetch a single Media resource associated with a specific Message resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
MessageSid | string | Yes | — | The SID of the Message resource that is associated with the Media resource. |
Sid | string | Yes | — | The Twilio-provided string that uniquely identifies the Media resource to fetch. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"MessageSid": {
"type": "string",
"description": "The SID of the Message resource that is associated with the Media resource."
},
"Sid": {
"type": "string",
"description": "The Twilio-provided string that uniquely identifies the Media resource to fetch."
}
},
"required": [
"PCID",
"MessageSid",
"Sid"
]
}
twilio_messaging_fetch_message
Fetch a specific Message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Sid | string | Yes | — | The SID of the Message resource to be fetched |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Sid": {
"type": "string",
"description": "The SID of the Message resource to be fetched"
}
},
"required": [
"PCID",
"Sid"
]
}
twilio_messaging_fetch_short_code
Fetch an instance of a short code Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Sid | string | Yes | — | The Twilio-provided string that uniquely identifies the ShortCode resource to fetch |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Sid": {
"type": "string",
"description": "The Twilio-provided string that uniquely identifies the ShortCode resource to fetch"
}
},
"required": [
"PCID",
"Sid"
]
}
twilio_messaging_list_media
Read a list of Media resources associated with a specific Message resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
MessageSid | string | Yes | — | The SID of the Message resource that is associated with the Media resources. |
DateCreated | string | No | — | Only include Media resources that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read Media that were created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read Media that were created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read Media that were created on or after midnight of this date. |
DateCreated< | string | No | — | Only include Media resources that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read Media that were created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read Media that were created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read Media that were created on or after midnight of this date. |
DateCreated> | string | No | — | Only include Media resources that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read Media that were created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read Media that were created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read Media that were created on or after midnight of this date. |
PageSize | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
Page | integer | No | — | The page index. This value is simply for client state. |
PageToken | string | No | — | The page token. This is provided by the API. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"MessageSid": {
"type": "string",
"description": "The SID of the Message resource that is associated with the Media resources."
},
"DateCreated": {
"type": "string",
"description": "Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were created on or after midnight of this date."
},
"DateCreated<": {
"type": "string",
"description": "Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were created on or after midnight of this date."
},
"DateCreated>": {
"type": "string",
"description": "Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read Media that were created on or after midnight of this date."
},
"PageSize": {
"type": "integer",
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000."
},
"Page": {
"type": "integer",
"description": "The page index. This value is simply for client state."
},
"PageToken": {
"type": "string",
"description": "The page token. This is provided by the API."
}
},
"required": [
"PCID",
"MessageSid"
]
}
twilio_messaging_list_message
Retrieve a list of Message resources associated with a Twilio Account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
To | string | No | — | Filter by recipient. For example: Set this parameter to +15558881111 to retrieve a list of Message resources sent to +15558881111. |
From | string | No | — | Filter by sender. For example: Set this parameter to +15552229999 to retrieve a list of Message resources sent by +15552229999. |
DateSent | string | No | — | Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date). |
DateSent< | string | No | — | Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date). |
DateSent> | string | No | — | Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date). |
PageSize | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
Page | integer | No | — | The page index. This value is simply for client state. |
PageToken | string | No | — | The page token. This is provided by the API. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"To": {
"type": "string",
"description": "Filter by recipient. For example: Set this parameter to `+15558881111` to retrieve a list of Message resources sent to `+15558881111`."
},
"From": {
"type": "string",
"description": "Filter by sender. For example: Set this parameter to `+15552229999` to retrieve a list of Message resources sent by `+15552229999`."
},
"DateSent": {
"type": "string",
"description": "Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date)."
},
"DateSent<": {
"type": "string",
"description": "Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date)."
},
"DateSent>": {
"type": "string",
"description": "Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date)."
},
"PageSize": {
"type": "integer",
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000."
},
"Page": {
"type": "integer",
"description": "The page index. This value is simply for client state."
},
"PageToken": {
"type": "string",
"description": "The page token. This is provided by the API."
}
},
"required": [
"PCID"
]
}
twilio_messaging_list_short_code
Retrieve a list of short-codes belonging to the account used to make the request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
FriendlyName | string | No | — | The string that identifies the ShortCode resources to read. |
ShortCode | string | No | — | Only show the ShortCode resources that match this pattern. You can specify partial numbers and use ’*’ as a wildcard for any digit. |
PageSize | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
Page | integer | No | — | The page index. This value is simply for client state. |
PageToken | string | No | — | The page token. This is provided by the API. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"FriendlyName": {
"type": "string",
"description": "The string that identifies the ShortCode resources to read."
},
"ShortCode": {
"type": "string",
"description": "Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit."
},
"PageSize": {
"type": "integer",
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000."
},
"Page": {
"type": "integer",
"description": "The page index. This value is simply for client state."
},
"PageToken": {
"type": "string",
"description": "The page token. This is provided by the API."
}
},
"required": [
"PCID"
]
}
twilio_messaging_update_message
Update a Message resource (used to redact Messagebody text and to cancel not-yet-sent messages)
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Sid | string | Yes | — | The SID of the Message resource to be updated |
Body | string | No | — | The new body of the Message resource. To redact the text content of a Message, this parameter’s value must be an empty string |
Status | string | No | — | The status value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Sid": {
"type": "string",
"description": "The SID of the Message resource to be updated"
},
"Body": {
"type": "string",
"description": "The new `body` of the Message resource. To redact the text content of a Message, this parameter's value must be an empty string"
},
"Status": {
"type": "string",
"description": "The status value",
"enum": [
"canceled"
]
}
},
"required": [
"PCID",
"Sid"
]
}
twilio_messaging_update_short_code
Update a short code with the following parameters Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Sid | string | Yes | — | The Twilio-provided string that uniquely identifies the ShortCode resource to update |
ApiVersion | string | No | — | The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. |
FriendlyName | string | No | — | A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the FriendlyName is the short code. |
SmsFallbackMethod | string | No | — | The HTTP method that we should use to call the sms_fallback_url. Can be: GET or POST. |
SmsFallbackUrl | string | No | — | The URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url. |
SmsMethod | string | No | — | The HTTP method we should use when calling the sms_url. Can be: GET or POST. |
SmsUrl | string | No | — | The URL we should call when receiving an incoming SMS message to this short code. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Sid": {
"type": "string",
"description": "The Twilio-provided string that uniquely identifies the ShortCode resource to update"
},
"ApiVersion": {
"type": "string",
"description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`."
},
"FriendlyName": {
"type": "string",
"description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code."
},
"SmsFallbackMethod": {
"type": "string",
"description": "The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`.",
"enum": [
"GET",
"POST"
]
},
"SmsFallbackUrl": {
"type": "string",
"description": "The URL that we should call if an error occurs while retrieving or executing the TwiML from `sms_url`."
},
"SmsMethod": {
"type": "string",
"description": "The HTTP method we should use when calling the `sms_url`. Can be: `GET` or `POST`.",
"enum": [
"GET",
"POST"
]
},
"SmsUrl": {
"type": "string",
"description": "The URL we should call when receiving an incoming SMS message to this short code."
}
},
"required": [
"PCID",
"Sid"
]
}