Fetch us app to person

GET /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}

A service for (fetch/create/delete) A2P Campaign for a Messaging Service

Path parameters

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • brand_registration_sid string | null

      A2P Brand Registration SID

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BN[0-9a-fA-F]{32}$.

    • campaign_id string | null

      The Campaign Registry (TCR) Campaign ID.

    • campaign_status string | null

      Campaign status

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • description string | null

      A short description of what this SMS campaign does

    • has_embedded_links boolean | null

      Indicate that this SMS campaign will send messages that contain links

    • has_embedded_phone boolean | null

      Indicates that this SMS campaign will send messages that contain phone numbers

    • is_externally_registered boolean | null

      Indicates whether the campaign was registered externally or not

    • message_samples array[string] | null

      Message samples

    • messaging_service_sid string | null

      The SID of the Messaging Service the resource is associated with

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

    • mock boolean | null

      A boolean that specifies whether campaign is a mock or not.

    • rate_limits

      Rate limit and/or classification set by each carrier

    • sid string | null

      The unique string that identifies a US A2P Compliance resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^QE[0-9a-fA-F]{32}$.

    • url string(uri) | null

      The absolute URL of the US App to Person resource

    • us_app_to_person_usecase string | null

      A2P Campaign Use Case.
GET /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid} 
curl \
 -X GET https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid} \
 --user "username:password"
Response examples (200) 
{
  "account_sid": "string",
  "brand_registration_sid": "string",
  "campaign_id": "string",
  "campaign_status": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "description": "string",
  "has_embedded_links": true,
  "has_embedded_phone": true,
  "is_externally_registered": true,
  "message_samples": [
    "string"
  ],
  "messaging_service_sid": "string",
  "mock": true,
  "sid": "string",
  "url": "https://example.com",
  "us_app_to_person_usecase": "string"
}