メニュー

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Map Resource

A Sync Map is an unordered collection of individual Map items.

You can find the full API reference documentation for Sync Map Items here.

A few notes about Sync Maps:

  • Full map modification history persists with every change that triggers a new revision.
  • Strict ordering of map mutation events is guaranteed, but the map item order is not defined.
  • By default, data persists permanently, but maps will expire and be deleted automatically if eviction is configured via the TTL parameter.

Map properties

Each Map object root resource has the following properties.

Unique name and expiration date attributes are optional and may be null.

Names in PHP format
sid
sid<MP> Not PII

The unique 34-character SID identifier of the Map.

uniqueName
文字列 PII MTL: 30 DAYS

The unique and addressable name of this Map. Optional, up to 320 characters long.

accountSid
sid<AC> Not PII

The unique SID identifier of the Twilio Account.

serviceSid
sid<IS> Not PII

The unique SID identifier of the Service Instance that hosts this Map object.

url
url Not PII

The absolute URL for this Map.

links
uri_map Not PII

A dictionary of URL links to nested resources of this Map.

revision
文字列 Not PII

Contains the current revision of this Map, represented by a string identifier.

dateExpires
date_time<iso8601> Not PII

Contains the date this Map expires and gets deleted automatically. Contains null if the Map persists permanently.

dateCreated
date_time<iso8601> Not PII

The date this Map was created, given in UTC ISO 8601 format.

dateUpdated
date_time<iso8601> Not PII

Specifies the date this Map was last updated, given in UTC ISO 8601 format.

createdBy
文字列 PII MTL: 30 DAYS

The identity of the Map creator. If the Map is created from the client SDK, the value matches the Access Token's identity field. If the Map was created from the REST API, the value is system.

Create a SyncMap resource

post
https://sync.twilio.com/v1/Services/{ServiceSid}/Maps

Create a new Map in this Service Instance, optionally giving it a unique name and assigning an expiration deadline.

パラメーター
Names in None format
unique_name
オプション
post 文字列 PII MTL: 30 DAYS

Human-readable name for this map

ttl
オプション
post integer Not PII

Alias for collection_ttl. If both are provided, this value is ignored.

collection_ttl
オプション
post integer Not PII

Time-to-live of this Map in seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.

例 1
        
        
        
        
        例 2
              
              
              
              
              例 3
                    
                    
                    
                    
                    Set TTL (in seconds) for expiring this Map instance

                    Create a Map with an expiration deadline

                    Set TTL (in seconds) for expiring this Map instance

                    Fetch a SyncMap resource

                    GET
                    https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{Sid}
                          
                          
                          
                          

                          Read multiple SyncMap resources

                          GET
                          https://sync.twilio.com/v1/Services/{ServiceSid}/Maps

                          Retrieve a list of all Maps belonging to this Service Instance.

                          By default, this will return the first 50 Maps. Supply a PageSize parameter to fetch up to 100 items at once. See paging for more information.

                                
                                
                                
                                

                                Update a SyncMap resource

                                post
                                https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{Sid}
                                パラメーター
                                Names in None format
                                ttl
                                オプション
                                post integer Not PII

                                Alias for collection_ttl. If both are provided, this value is ignored.

                                collection_ttl
                                オプション
                                post integer Not PII

                                New time-to-live of this Map in seconds. In the range [1, 31 536 000 (1 year)], or 0 for infinity.

                                      
                                      
                                      
                                      

                                      Delete a Map resource

                                      削除する
                                      https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{Sid}

                                      Permanently delete a specific Map along with all items belonging to it from a given Sync Service Instance.

                                      例 1
                                            
                                            
                                            
                                            
                                            Rate this page:

                                            ヘルプが必要ですか?

                                            誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。