Sign in
ConversationsV1AddressConfiguration

Fetch an address configuration

Fetch an address configuration

get/v1/Configuration/Addresses/{Sid}

Path parameters

Sidstring required

The SID of the Address Configuration resource. This value can be either the sid or the address of the configuration

Response

OK

sidstring nullable

A 34 character string that uniquely identifies this resource.

account_sidstring nullable

The unique ID of the Account the address belongs to

typestring nullable

Type of Address, value can be whatsapp or sms.

addressstring nullable

The unique address to be configured. The address can be a whatsapp address or phone number

friendly_namestring nullable

The human-readable name of this configuration, limited to 256 characters. Optional.

{"stackTrail":"components:schemas:conversations.v1.configuration_address:properties:auto_creation","oasType":"schema","type":"unknown","description":"Auto Creation configuration for the address.","nullable":true}
date_createdstring date-time nullable

The date that this resource was created.

date_updatedstring date-time nullable

The date that this resource was last updated.

urlstring uri nullable

An absolute API resource URL for this address configuration.

address_countrystring nullable

An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.

Changes

Changed in 4 of the 51 revisions of this API.22

  • v192d1169c37c21See the full diff
    • ▲

      the auto_creation response's property type/format changed from object/ to / for status 200

      response-property-type-changed

  • v1b4d0e634cd691See the full diff
    • ▲

      the auto_creation response's property type/format changed from / to object/ for status 200

      response-property-type-changed

  • v14e3f150aaa781See the full diff
    • ○

      api tag ConversationsV1AddressConfiguration added

      api-tag-added

  • v1c97a0ea6ca201See the full diff
    • ○

      added the optional property address_country to the response with the 200 status

      response-optional-property-added