class Twilio::SMSApi
- Twilio::SMSApi
- Reference
- Object
Defined in:
twilio/api/sms_api.crConstant Summary
-
FETCH_SHORT_CODE_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_SHORT_CODE_MAX_LENGTH_FOR_SID =
34 -
FETCH_SHORT_CODE_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_SHORT_CODE_MIN_LENGTH_FOR_SID =
34 -
FETCH_SHORT_CODE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
FETCH_SHORT_CODE_PATTERN_FOR_SID =
/^SC[0-9a-fA-F]{32}$/ -
LIST_SHORT_CODE_MAX_FOR_PAGE_SIZE =
Int32.new("1000") -
LIST_SHORT_CODE_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_SHORT_CODE_MIN_FOR_PAGE_SIZE =
Int32.new("1") -
LIST_SHORT_CODE_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_SHORT_CODE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
UPDATE_SHORT_CODE_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_SHORT_CODE_MAX_LENGTH_FOR_SID =
34 -
UPDATE_SHORT_CODE_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_SHORT_CODE_MIN_LENGTH_FOR_SID =
34 -
UPDATE_SHORT_CODE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
UPDATE_SHORT_CODE_PATTERN_FOR_SID =
/^SC[0-9a-fA-F]{32}$/
Constructors
Instance Method Summary
- #account_sid : String
- #account_sid=(account_sid : String)
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_fetch_short_code(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_short_code(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, short_code : String | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update_short_code(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, api_version : String | Nil = nil, friendly_name : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_url : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#fetch_short_code(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::ShortCode
Fetch an instance of a short code @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to fetch.
-
#fetch_short_code(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch an instance of a short code @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to fetch.
-
#fetch_short_code_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::ShortCode, Int32, Hash(String, Array(String) | String))
Fetch an instance of a short code @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to fetch.
-
#list_short_code(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, short_code : String | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListShortCodeResponse
Retrieve a list of short-codes belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to read.
-
#list_short_code(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, short_code : String | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a list of short-codes belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to read.
-
#list_short_code_with_http_info(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, short_code : String | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListShortCodeResponse, Int32, Hash(String, Array(String) | String))
Retrieve a list of short-codes belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to read.
-
#update_short_code(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, api_version : String | Nil = nil, friendly_name : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_url : String | Nil = nil) : Twilio::ShortCode
Update a short code with the following parameters @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to update.
-
#update_short_code(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, api_version : String | Nil = nil, friendly_name : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_url : String | Nil = nil, &block : Crest::Response -> ) : Nil
Update a short code with the following parameters @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to update.
-
#update_short_code_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, api_version : String | Nil = nil, friendly_name : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_url : String | Nil = nil) : Tuple(Twilio::ShortCode, Int32, Hash(String, Array(String) | String))
Update a short code with the following parameters @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to update.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
Fetch an instance of a short code @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ShortCode resource to fetch @return [Twilio::ShortCode]
Fetch an instance of a short code @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ShortCode resource to fetch @return nil
Fetch an instance of a short code @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ShortCode resource to fetch @return [Tuple(Twilio::ShortCode, Integer, Hash)] Twilio::ShortCode, response status code and response headers
Retrieve a list of short-codes belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to read. @optional @param friendly_name [String?] The string that identifies the ShortCode resources to read. @optional @param short_code [String?] Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListShortCodeResponse]
Retrieve a list of short-codes belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to read. @optional @param friendly_name [String?] The string that identifies the ShortCode resources to read. @optional @param short_code [String?] Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil
Retrieve a list of short-codes belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to read. @optional @param friendly_name [String?] The string that identifies the ShortCode resources to read. @optional @param short_code [String?] Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListShortCodeResponse, Integer, Hash)] Twilio::ListShortCodeResponse, response status code and response headers
Update a short code with the following parameters
@required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the ShortCode resource to update
@optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01.
@optional @param friendly_name [String?] 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.
@optional @param sms_fallback_method [Twilio::HttpMethod?]
@optional @param sms_fallback_url [String?] The URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url.
@optional @param sms_method [Twilio::HttpMethod?]
@optional @param sms_url [String?] The URL we should call when receiving an incoming SMS message to this short code.
@return [Twilio::ShortCode]
Update a short code with the following parameters
@required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the ShortCode resource to update
@optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01.
@optional @param friendly_name [String?] 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.
@optional @param sms_fallback_method [Twilio::HttpMethod?]
@optional @param sms_fallback_url [String?] The URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url.
@optional @param sms_method [Twilio::HttpMethod?]
@optional @param sms_url [String?] The URL we should call when receiving an incoming SMS message to this short code.
@return nil
Update a short code with the following parameters
@required @param account_sid [String?] The SID of the Account that created the ShortCode resource(s) to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the ShortCode resource to update
@optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01.
@optional @param friendly_name [String?] 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.
@optional @param sms_fallback_method [Twilio::HttpMethod?]
@optional @param sms_fallback_url [String?] The URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url.
@optional @param sms_method [Twilio::HttpMethod?]
@optional @param sms_url [String?] The URL we should call when receiving an incoming SMS message to this short code.
@return [Tuple(Twilio::ShortCode, Integer, Hash)] Twilio::ShortCode, response status code and response headers