Twilio Messenger

Edit on GitHubEdit MD

version

Available since version 1.26.0

The following APIs are provided to manage Twilio Messengers.

Create the Twilio Messenger#

Request#

Create a Twilio Messenger with a randomly generated Id.

POST/api/messenger

OpenAPI Spec

Create a Twilio Messenger with the provided unique Id.

POST/api/messenger/{messengerId}

OpenAPI Spec

The type in the request JSON is used to determine that you are creating the Twilio Messenger.

Request Parameters#

messengerId UUID optional Defaults to secure random UUID

The Id to use for the new Messenger. If not specified a secure random UUID will be generated.

Request Body#

messenger.accountSID String required

The Twilio Account ID to use when connecting to the Twilio API. This can be found in your Twilio dashboard.

messenger.authToken String optional

The Twilio Auth Token to use when connecting to the Twilio API. This can be found in your Twilio dashboard.

messenger.data Object optional

An object that can hold any information about the Messenger that should be persisted.

messenger.debug Boolean optional Defaults to false

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.messageTypes Array<String> optional Defaults to ["SMS"] Available since 1.65.0

The set of message types this messenger can send.

Supported values include:

SMS
Voice

messenger.fromPhoneNumber String optional

The configured Twilio phone number that will be used to send messages. This can be found in your Twilio dashboard.

messenger.messagingServiceSid String optional

The Twilio message service Id, this is used when using Twilio Copilot to load balance between numbers. This can be found in your Twilio dashboard.

When using messagingServicesSid, you may omit the fromPhoneNumber field.

messenger.name String required

The unique Messenger name.

messenger.url String required

The fully qualified URL of the Twilio API endpoint that will accept requests from FusionAuth.

Example Request JSON

{
  "messenger": {
    "accountSID": "983C6FACEBBE4D858570FADD967A9DD7",
    "authToken": "184C73BE8E44420EBAA0BA147A61B6A9",
    "data": {
      "foo": "bar"
    },
    "debug": false,
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "fromPhoneNumber": "555-555-5555",
    "name": "Twilio Messenger",
    "type": "Twilio",
    "url": "https://api.twilio.com"
  }
}

Response#

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

messenger.accountSID String

The Twilio Account ID to use when connecting to the Twilio API.

messenger.authToken String

The Twilio Auth Token to use when connecting to the Twilio API.

messenger.data Object

An object that can hold any information about the Messenger that should be persisted.

messenger.debug Boolean

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.fromPhoneNumber String

The configured Twilio phone number that will be used to send messages.

messenger.id UUID

The unique Id of the Messenger.

messenger.insertInstant Long

The instant that the Messenger was added to the FusionAuth database.

messenger.lastUpdateInstant Long

The instant that the Messenger was last updated in the FusionAuth database.

messenger.messageTypes Array<String> Available since 1.65.0

The set of message types this messenger can send.

messenger.messagingServiceSid String

The Twilio message service Id, this is used when using Twilio Copilot to load balance between numbers.

When using messagingServicesSid, you may omit the fromPhoneNumber field.

messenger.name String

The unique Messenger name.

messenger.transport String Available since 1.26.0

Deprecated. This legacy field remains for backward compatibility. Use messenger.messageTypes instead.

messenger.type String

This field will always be Twilio.

messenger.url String

The fully qualified URL of the Twilio API endpoint that will accept requests from FusionAuth.

Example Response JSON

{
  "messenger": {
    "accountSID": "983C6FACEBBE4D858570FADD967A9DD7",
    "authToken": "184C73BE8E44420EBAA0BA147A61B6A9",
    "data": {
      "foo": "bar"
    },
    "debug": false,
    "fromPhoneNumber": "555-555-5555",
    "id": "f49c3b86-91fe-48f7-ae46-d166eead0166",
    "insertInstant": 1562189072183,
    "lastUpdateInstant": 1562189072183,
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "name": "Twilio Messenger",
    "transport": "sms",
    "type": "Twilio",
    "url": "https://api.twilio.com"
  }
}

Retrieve the Twilio Messenger#

Request#

Retrieve the Twilio Messenger by Id

GET/api/messenger/{messengerId}

OpenAPI Spec

Request Parameters#

messengerId UUID required

The Id of the Messenger to retrieve.

Response#

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

messenger.accountSID String

The Twilio Account ID to use when connecting to the Twilio API.

messenger.authToken String

The Twilio Auth Token to use when connecting to the Twilio API.

messenger.data Object

An object that can hold any information about the Messenger that should be persisted.

messenger.debug Boolean

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.fromPhoneNumber String

The configured Twilio phone number that will be used to send messages.

messenger.id UUID

The unique Id of the Messenger.

messenger.insertInstant Long

The instant that the Messenger was added to the FusionAuth database.

messenger.lastUpdateInstant Long

The instant that the Messenger was last updated in the FusionAuth database.

messenger.messageTypes Array<String> Available since 1.65.0

The set of message types this messenger can send.

messenger.messagingServiceSid String

The Twilio message service Id, this is used when using Twilio Copilot to load balance between numbers.

When using messagingServicesSid, you may omit the fromPhoneNumber field.

messenger.name String

The unique Messenger name.

messenger.transport String Available since 1.26.0

Deprecated. This legacy field remains for backward compatibility. Use messenger.messageTypes instead.

messenger.type String

This field will always be Twilio.

messenger.url String

The fully qualified URL of the Twilio API endpoint that will accept requests from FusionAuth.

Example Response JSON

{
  "messenger": {
    "accountSID": "983C6FACEBBE4D858570FADD967A9DD7",
    "authToken": "184C73BE8E44420EBAA0BA147A61B6A9",
    "data": {
      "foo": "bar"
    },
    "debug": false,
    "fromPhoneNumber": "555-555-5555",
    "id": "f49c3b86-91fe-48f7-ae46-d166eead0166",
    "insertInstant": 1562189072183,
    "lastUpdateInstant": 1562189072183,
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "name": "Twilio Messenger",
    "transport": "sms",
    "type": "Twilio",
    "url": "https://api.twilio.com"
  }
}

Update the Twilio Messenger#

This API is used to update an existing Twilio Messenger.

You must specify all of the properties of the Twilio Messenger when calling this API with the PUT HTTP method. When used with PUT, this API doesn't merge the existing Twilio Messenger and your new data. It replaces the existing Twilio Messenger with your new data.

Utilize the PATCH HTTP method to send specific changes to merge into an existing Twilio Messenger.

Request#

Update the Twilio Messenger by Id

PUT/api/messenger/{messengerId}

OpenAPI Spec

PATCH/api/messenger/{messengerId}

OpenAPI Spec

note

For backward compatibility, the PATCH method accepts the same media type (specified by a Content-Type of application/json) and body as the PUT request. You can also use the following media types for different behavior:

JSON Patch/RFC 6902: application/json-patch+json
JSON Merge Patch/RFC 7396: merge-patch+json

For details, see the PATCH documentation.

Using a media type of application/json merges the provided request parameters into the existing object. As a result, all parameters are optional with PATCH: only provide the values you want to change. To remove a value, provide a null value. Patching an Array appends all values in the new list to the old list.

Request Parameters#

messengerId UUID required

The Id of the Messenger to update.

Request Body#

messenger.accountSID String required

The Twilio Account ID to use when connecting to the Twilio API. This can be found in your Twilio dashboard.

messenger.authToken String optional

The Twilio Auth Token to use when connecting to the Twilio API. This can be found in your Twilio dashboard.

messenger.data Object optional

An object that can hold any information about the Messenger that should be persisted.

messenger.debug Boolean optional Defaults to false

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.messageTypes Array<String> optional Defaults to ["SMS"] Available since 1.65.0

The set of message types this messenger can send.

Supported values include:

SMS
Voice

messenger.fromPhoneNumber String optional

The configured Twilio phone number that will be used to send messages. This can be found in your Twilio dashboard.

messenger.messagingServiceSid String optional

The Twilio message service Id, this is used when using Twilio Copilot to load balance between numbers. This can be found in your Twilio dashboard.

When using messagingServicesSid, you may omit the fromPhoneNumber field.

messenger.name String required

The unique Messenger name.

messenger.url String required

The fully qualified URL of the Twilio API endpoint that will accept requests from FusionAuth.

Example Request JSON

{
  "messenger": {
    "accountSID": "983C6FACEBBE4D858570FADD967A9DD7",
    "authToken": "184C73BE8E44420EBAA0BA147A61B6A9",
    "data": {
      "foo": "bar"
    },
    "debug": false,
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "fromPhoneNumber": "555-555-5555",
    "name": "Twilio Messenger",
    "type": "Twilio",
    "url": "https://api.twilio.com"
  }
}

Response#

The response for this API contains the Twilio Messenger.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you are trying to update doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

messenger.accountSID String

The Twilio Account ID to use when connecting to the Twilio API.

messenger.authToken String

The Twilio Auth Token to use when connecting to the Twilio API.

messenger.data Object

An object that can hold any information about the Messenger that should be persisted.

messenger.debug Boolean

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.fromPhoneNumber String

The configured Twilio phone number that will be used to send messages.

messenger.id UUID

The unique Id of the Messenger.

messenger.insertInstant Long

The instant that the Messenger was added to the FusionAuth database.

messenger.lastUpdateInstant Long

The instant that the Messenger was last updated in the FusionAuth database.

messenger.messageTypes Array<String> Available since 1.65.0

The set of message types this messenger can send.

messenger.messagingServiceSid String

The Twilio message service Id, this is used when using Twilio Copilot to load balance between numbers.

When using messagingServicesSid, you may omit the fromPhoneNumber field.

messenger.name String

The unique Messenger name.

messenger.transport String Available since 1.26.0

Deprecated. This legacy field remains for backward compatibility. Use messenger.messageTypes instead.

messenger.type String

This field will always be Twilio.

messenger.url String

The fully qualified URL of the Twilio API endpoint that will accept requests from FusionAuth.

Example Response JSON

{
  "messenger": {
    "accountSID": "983C6FACEBBE4D858570FADD967A9DD7",
    "authToken": "184C73BE8E44420EBAA0BA147A61B6A9",
    "data": {
      "foo": "bar"
    },
    "debug": false,
    "fromPhoneNumber": "555-555-5555",
    "id": "f49c3b86-91fe-48f7-ae46-d166eead0166",
    "insertInstant": 1562189072183,
    "lastUpdateInstant": 1562189072183,
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "name": "Twilio Messenger",
    "transport": "sms",
    "type": "Twilio",
    "url": "https://api.twilio.com"
  }
}

Delete the Twilio Messenger#

Request#

Delete the Twilio Messenger by Id

DELETE/api/messenger/{messengerId}

OpenAPI Spec

messengerId UUID required

The Id of the Messenger to delete.

Response#

This API does not return a JSON response body.

Response Codes

Code	Description
200	The request was successful.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.