FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
    • Getting Started
    • 5-minute Setup Guide
      • Overview
      • Docker
      • Fast Path
      • Sandbox
    • Setup Wizard & First Login
    • Register a User and Login
    • Self-service Registration
    • Start and Stop FusionAuth
    • Core Concepts
      • Overview
      • Users
      • Roles
      • Groups
      • Registrations
      • Applications
      • Tenants
      • Identity Providers
      • Authentication/Authorization
      • Integration Points
    • Example Apps
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • PHP
      • Python
      • Ruby
    • Tutorials
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Marketplaces
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Microsoft Azure AD B2C
    • Tutorial
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Editions and Features
    • Key Rotation
    • Licensing
    • Monitoring
    • Prometheus Setup
    • Proxy Setup
    • Reference
      • Overview
      • Configuration
      • CORS
      • Data Types
      • Hosted Login Pages Cookies
      • Known Limitations
      • Password Hashes
    • Releases
    • Roadmap
    • Search And FusionAuth
    • Securing
    • Switch Search Engines
    • Technical Support
    • Troubleshooting
    • Upgrading
    • WebAuthn
  • Login Methods
    • Identity Providers
      • Overview
      • Apple
      • Epic Games
      • External JWT
        • Overview
        • Example
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
        • Overview
        • Amazon Cognito
        • Azure AD
        • Discord
        • Github
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • ngrok Cloud Edge
    • Client Libraries & SDKs
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • Node
      • OpenAPI
      • PHP
      • Python
      • React
      • Ruby
      • Typescript
    • Events & Webhooks
      • Overview
      • Writing a Webhook
      • Securing Webhooks
      • Events
        • Overview
        • Audit Log Create
        • Event Log Create
        • JWT Public Key Update
        • JWT Refresh
        • JWT Refresh Token Revoke
        • Kickstart Success
        • Group Create
        • Group Create Complete
        • Group Delete
        • Group Delete Complete
        • Group Update
        • Group Update Complete
        • Group Member Add
        • Group Member Add Complete
        • Group Member Remove
        • Group Member Remove Complete
        • Group Member Update
        • Group Member Update Complete
        • User Action
        • User Bulk Create
        • User Create
        • User Create Complete
        • User Deactivate
        • User Delete
        • User Delete Complete
        • User Email Update
        • User Email Verified
        • User IdP Link
        • User IdP Unlink
        • User Login Failed
        • User Login Id Dup. Create
        • User Login Id Dup. Update
        • User Login New Device
        • User Login Success
        • User Login Suspicious
        • User Password Breach
        • User Password Reset Send
        • User Password Reset Start
        • User Password Reset Success
        • User Password Update
        • User Reactivate
        • User Reg. Create
        • User Reg. Create Complete
        • User Reg. Delete
        • User Reg. Delete Complete
        • User Registration Update
        • User Reg. Update Complete
        • User Reg. Verified
        • User 2FA Method Add
        • User 2FA Method Remove
        • User Update
        • User Update Complete
    • Guides
      • Overview
      • Authentication Tokens
      • Exposing A Local Instance
      • JSON Web Tokens
      • Key Master
      • Localization and Internationalization
      • Multi-Factor Authentication
      • Multi-Tenant
      • Passwordless
      • Registration-based Email Verification
      • Searching With Elasticsearch
      • Securing Your APIs
      • Silent Mode
      • Single Sign-on
      • Two Factor (pre 1.26)
    • Integrations
      • Overview
      • CleanSpeak
      • Kafka
      • Twilio
    • Plugins
      • Overview
      • Writing a Plugin
      • Custom Password Hashing
    • User Control & Gating
      • Overview
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
  • Customization
    • Email & Templates
      • Overview
      • Configure Email
      • Email Templates
      • Email Variables
      • Message Templates
    • Lambdas
      • Overview
      • Apple Reconcile
      • Client Cred. JWT Populate
      • Epic Games Reconcile
      • External JWT Reconcile
      • Facebook Reconcile
      • Google Reconcile
      • HYPR Reconcile
      • JWT Populate
      • LDAP Connector Reconcile
      • LinkedIn Reconcile
      • Nintendo Reconcile
      • OpenID Connect Reconcile
      • SAML v2 Populate
      • SAML v2 Reconcile
      • SCIM Group Req. Converter
      • SCIM Group Resp. Convtr.
      • SCIM User Req. Converter
      • SCIM User Resp. Converter
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
  • Premium Features
    • Overview
    • Advanced Registration Forms
    • Advanced Threat Detection
    • Application Specific Themes
    • Breached Password Detection
    • Connectors
      • Overview
      • Generic Connector
      • LDAP Connector
      • FusionAuth Connector
    • Entity Management
    • SCIM
      • Overview
      • Azure AD Client
      • Okta Client
      • SCIM-SDK
    • Self Service Account Mgmt
      • Overview
      • Updating User Data & Password
      • Add Two-Factor Authenticator
      • Add Two-Factor Email
      • Add Two-Factor SMS
      • Add WebAuthn Passkey
      • Customizing
      • Troubleshooting
    • WebAuthn
  • APIs
    • Overview
    • Authentication
    • Errors
    • API Explorer
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM User
      • SCIM Group
      • SCIM EnterpriseUser
      • SCIM Service Provider Config.
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • WebAuthn
    • Webhooks
  • Release Notes

    Twilio Messenger APIs

    Overview

    This API has been available since 1.26.0

    The following APIs are provided to manage Twilio Messengers.

    Operations

    • Create the Twilio Messenger

    • Retrieve the Twilio Messenger

    • Update the Twilio Messenger

    • Delete the Twilio Messenger

    Create the Twilio Messenger

    Request

    Create a Twilio Messenger with a randomly generated Id.

    URI

    POST /api/messenger

    Create a Twilio Messenger with the provided unique Id.

    URI

    POST /api/messenger/{messengerId}

    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.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,
        "fromPhoneNumber" : "555-555-5555",
        "name" : "Twilio Messenger",
        "type" : "Twilio",
        "url" : "https://api.twilio.com"
      }
    }

    Response

    Table 1. 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.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]

    The message transport protocol used to send a message. This value is currently read-only and set to sms.

    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,
        "name" : "Twilio Messenger",
        "transport" : "sms",
        "type" : "Twilio",
        "url" : "https://api.twilio.com"
      }
    }

    Retrieve the Twilio Messenger

    Request

    Retrieve the Twilio Messenger by Id

    URI

    GET /api/messenger/{messengerId}

    Request Parameters

    messengerId [UUID] Required

    The Id of the Messenger to retrieve.

    Response

    Table 2. 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.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]

    The message transport protocol used to send a message. This value is currently read-only and set to sms.

    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,
        "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 the Id of the Twilio Messenger you are updating on the URI.

    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

    URI

    PUT /api/messenger/{messengerId}

    PATCH /api/messenger/{messengerId}

    Available since 1.39.0

    When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902 or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.

    Available since 1.12.0

    When using the PATCH method, use the same request body documentation that is provided for the PUT request. The PATCH method will merge the provided request parameters into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A null value can be used to remove a value. Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.

     

    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.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,
        "fromPhoneNumber" : "555-555-5555",
        "name" : "Twilio Messenger",
        "type" : "Twilio",
        "url" : "https://api.twilio.com"
      }
    }

    Response

    The response for this API contains the Twilio Messenger.

    Table 3. 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.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]

    The message transport protocol used to send a message. This value is currently read-only and set to sms.

    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,
        "name" : "Twilio Messenger",
        "transport" : "sms",
        "type" : "Twilio",
        "url" : "https://api.twilio.com"
      }
    }

    Delete the Twilio Messenger

    Request

    Delete the Twilio Messenger by Id

    URI

    DELETE /api/messenger/{messengerId}

    messengerId [UUID] Required

    The Id of the Messenger to delete.

    Response

    This API does not return a JSON response body.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    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 delete 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.

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.

    © 2023 FusionAuth
    Subscribe for developer updates