Skip to main content

Retrieve a short code

GET 

/short_codes/:id

Retrieve a short code

Request

Path Parameters

    id uuidrequired

    The id of the short code

Responses

200: Successful response with details about a short code.

Schema

    data

    object

    record_type string

    Possible values: [short_code]

    Identifies the type of the resource.

    id uuid

    Identifies the type of resource.

    short_code string

    Short digit sequence used to address messages.

    country_code string

    Possible values: Value must match regular expression ^[A-Z]{2}$

    ISO 3166-1 alpha-2 country code.

    messaging_profile_id stringnullablerequired

    Unique identifier for a messaging profile.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...