Path parameters

• Sid string Required

  The SID of the Service resource to fetch.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • sid string | null

    The unique string that we created to identify the Service resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

  • account_sid string | null

    The SID of the Account that created the Service resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • friendly_name string | null

    The string that you assigned to describe the resource.

  • date_created string(date-time) | null

    The date and time in GMT when the resource was created specified in ISO 8601 format.

  • date_updated string(date-time) | null

    The date and time in GMT when the resource was last updated specified in ISO 8601 format.

  • inbound_request_url string(uri) | null

    The URL we call using inbound_method when a message is received by any phone number or short code in the Service. When this property is null, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the use_inbound_webhook_on_number field is enabled then the webhook url defined on the phone number will override the inbound_request_url defined for the Messaging Service.

  • inbound_method string(http-method) | null

    The HTTP method we use to call inbound_request_url. Can be GET or POST.

    Values are GET or POST.

  • fallback_url string(uri) | null

    The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the use_inbound_webhook_on_number field is enabled then the webhook url defined on the phone number will override the fallback_url defined for the Messaging Service.

  • fallback_method string(http-method) | null

    The HTTP method we use to call fallback_url. Can be: GET or POST.

    Values are GET or POST.

  • status_callback string(uri) | null

    The URL we call to pass status updates about message delivery.

  • sticky_sender boolean | null

    Whether to enable Sticky Sender on the Service instance.

  • mms_converter boolean | null

    Whether to enable the MMS Converter for messages sent through the Service instance.

  • smart_encoding boolean | null

    Whether to enable Smart Encoding for messages sent through the Service instance.

  • scan_message_content string

    Reserved.

    Values are inherit, enable, or disable.

  • fallback_to_long_code boolean | null

    [OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.

  • area_code_geomatch boolean | null

    Whether to enable Area Code Geomatch on the Service Instance.

  • synchronous_validation boolean | null

    Reserved.

  • validity_period integer

    How long, in seconds, messages sent from the Service are valid. Can be an integer from 1 to 36,000. Default value is 36,000.

    Default value is 0.

  • url string(uri) | null

    The absolute URL of the Service resource.

  • links object(uri-map) | null

    The absolute URLs of related resources.

  • usecase string | null

    A string that describes the scenario in which the Messaging Service will be used. Possible values are notifications, marketing, verification, discussion, poll, undeclared.

  • us_app_to_person_registered boolean | null

    Whether US A2P campaign is registered for this Service.

  • use_inbound_webhook_on_number boolean | null

    A boolean value that indicates either the webhook url configured on the phone number will be used or inbound_request_url/fallback_url url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the inbound_request_url/fallback_url defined for the Messaging Service.