サービスリソース

公開ベータ

The Service Resource is currently available as a Public Beta product. This means that some features for configuring your Messaging Service via the REST API are not yet implemented, and others may be changed before the product is declared Generally Available. Messaging Service Configuration through the Twilio Console is Generally Available.

Public Beta products are not covered by a Twilio SLA.

The resources for sending Messages with a Messaging Service are Generally Available.

When sending a message with a Messaging Service, you can improve message performance by enabling the included features.

Developers can associate phone numbers, short codes, and alpha sender IDs to an instance of a Messaging Service. The Service handles all inbound and outbound behaviors for the phone numbers and shortcodes.

Twilio コンソール

Messaging ServiceはTwilio Consoleにログインして管理可能です。

Messaging Servicesリソース

MessagingのServicesリソースはメッセージの送受信に関係する一連の構成を表します。

サブリソース

ServicesリソースにはそのServiceに関連づけられた電話番号、ショートコード、および英文字の送信者IDを管理するためのphone numbers、shortcodes、およびalpha sender IDsサブリソースががあります。

リソースURI

このドキュメント中のすべてのURLは下記のベースURLを使用しています:

https://messaging.twilio.com/v1

Service properties

Resource Properties in REST API format
`sid`	sid<MG> Not PII The unique string that we created to identify the Service resource.
`account_sid`	sid<AC> Not PII The SID of the Account that created the Service resource.
`friendly_name`	文字列 Not PII The string that you assigned to describe the resource.
`date_created`	date_time<iso8601> Not PII The date and time in GMT when the resource was created specified in ISO 8601 format.
`date_updated`	date_time<iso8601> Not PII The date and time in GMT when the resource was last updated specified in ISO 8601 format.
`inbound_request_url`	url Not PII 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`	http_method Not PII The HTTP method we use to call `inbound_request_url`. Can be `GET` or `POST`.
`fallback_url`	url Not PII 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`	http_method Not PII The HTTP method we use to call `fallback_url`. Can be: `GET` or `POST`.
`status_callback`	url Not PII The URL we call to pass status updates about message delivery.
`sticky_sender`	boolean Not PII Whether to enable Sticky Sender on the Service instance.
`mms_converter`	boolean Not PII Whether to enable the MMS Converter for messages sent through the Service instance.
`smart_encoding`	boolean Not PII Whether to enable Smart Encoding for messages sent through the Service instance.
`scan_message_content`	enum:scan_message_content Not PII Reserved.
`fallback_to_long_code`	boolean Not PII Whether to enable Fallback to Long Code for messages sent through the Service instance.
`area_code_geomatch`	boolean Not PII Whether to enable Area Code Geomatch on the Service Instance.
`synchronous_validation`	boolean Not PII Reserved.
`validity_period`	integer Not PII How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
`url`	url Not PII The absolute URL of the Service resource.
`links`	uri_map Not PII The absolute URLs of related resources.
`use_inbound_webhook_on_number`	boolean Not PII 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.

Create a Service resource

post

https://messaging.twilio.com/v1/Services

パラメーター

Parameters in REST API format
`friendly_name` 必須	post 文字列 Not PII A descriptive string that you create to describe the resource. It can be up to 64 characters long.
`inbound_request_url` オプション	post url Not PII 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` オプション	post http_method Not PII The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
`fallback_url` オプション	post url Not PII 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` オプション	post http_method Not PII The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
`status_callback` オプション	post url Not PII The URL we should call to pass status updates about message delivery.
`sticky_sender` オプション	post boolean Not PII Whether to enable Sticky Sender on the Service instance.
`mms_converter` オプション	post boolean Not PII Whether to enable the MMS Converter for messages sent through the Service instance.
`smart_encoding` オプション	post boolean Not PII Whether to enable Smart Encoding for messages sent through the Service instance.
`scan_message_content` オプション	post enum:scan_message_content Not PII Reserved.
`fallback_to_long_code` オプション	post boolean Not PII Whether to enable Fallback to Long Code for messages sent through the Service instance.
`area_code_geomatch` オプション	post boolean Not PII Whether to enable Area Code Geomatch on the Service Instance.
`validity_period` オプション	post integer Not PII How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
`synchronous_validation` オプション	post boolean Not PII Reserved.
`use_inbound_webhook_on_number` オプション	post boolean Not PII 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.

例 1

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

Create Service

Fetch a Service resource

GET

https://messaging.twilio.com/v1/Services/{Sid}

パラメーター

Parameters in REST API format
`sid` Path	GET sid<MG> Not PII The SID of the Service resource to fetch.

Parameters in REST API format

sid

Path

GET sid<MG> Not PII

The SID of the Service resource to fetch.

例 1

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

Fetch Service

Read multiple Service resources

GET

https://messaging.twilio.com/v1/Services

例 1

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

Read Service

Update a Service resource

post

https://messaging.twilio.com/v1/Services/{Sid}

1つ以上の上記のオプションパラメーターを指定して、Serviceの対応するプロパティーを更新できます。リクエストで指定されなかったパラメーターは更新されません。

パラメーター

Parameters in REST API format
`sid` Path	post sid<MG> Not PII The SID of the Service resource to update.
`friendly_name` オプション	post 文字列 Not PII A descriptive string that you create to describe the resource. It can be up to 64 characters long.
`inbound_request_url` オプション	post url Not PII 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` オプション	post http_method Not PII The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
`fallback_url` オプション	post url Not PII 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` オプション	post http_method Not PII The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
`status_callback` オプション	post url Not PII The URL we should call to pass status updates about message delivery.
`sticky_sender` オプション	post boolean Not PII Whether to enable Sticky Sender on the Service instance.
`mms_converter` オプション	post boolean Not PII Whether to enable the MMS Converter for messages sent through the Service instance.
`smart_encoding` オプション	post boolean Not PII Whether to enable Smart Encoding for messages sent through the Service instance.
`scan_message_content` オプション	post enum:scan_message_content Not PII Reserved.
`fallback_to_long_code` オプション	post boolean Not PII Whether to enable Fallback to Long Code for messages sent through the Service instance.
`area_code_geomatch` オプション	post boolean Not PII Whether to enable Area Code Geomatch on the Service Instance.
`validity_period` オプション	post integer Not PII How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
`synchronous_validation` オプション	post boolean Not PII Reserved.
`use_inbound_webhook_on_number` オプション	post boolean Not PII 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.