Get your channels

Every market you send SMS in, your WhatsApp account and your RCS agent — with each one's status, and what each market still owes.

Status lives on the channel, never on you or your brand. An identity has no lifecycle; what has one is the registration of a sender in a market and the approval of a channel. So a customer live in one country and mid-registration in another reports exactly that, rather than one flattened answer.

compliance[] carries one entry per market, naming the country and sender type it answers for. An empty requirements means that market is satisfied; anything listed is what to supply, and GET /v3/compliance/requirements describes each key in full.

Send x-profile-id with an organization key to read one of your profiles' channels.

GET
/v3/channels

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v3/channels"
{
  "success": true,
  "data": {
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "sms": [
      {
        "country": "string",
        "number_type": "string",
        "sender_value": "string",
        "status": "PROVISIONING",
        "compliance": {
          "brand": {
            "property1": null,
            "property2": null
          },
          "campaign": {
            "property1": null,
            "property2": null
          },
          "documents": [
            {
              "key": "string",
              "file_name": "string",
              "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6"
            }
          ]
        }
      }
    ],
    "whatsapp": {
      "waba_id": "string",
      "phone_number_id": "string",
      "solution_id": "string",
      "owner_business_id": "string",
      "status": "PROVISIONING"
    },
    "rcs": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "PROVISIONING",
      "phone_number": "string",
      "display_name": "string",
      "description": "string",
      "agent_use_case": "string",
      "brand_name": "string",
      "privacy_policy_url": "string",
      "terms_and_conditions_url": "string",
      "website_url": "string",
      "brand_color": "string",
      "brand_phone_number": "string",
      "customer_support_phone_number": "string",
      "brand_email": "string",
      "customer_support_email": "string",
      "contact_name_and_title": "string",
      "company_ein": "string",
      "entity_type": "string",
      "official_address": {
        "street": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country": "string"
      },
      "brief_company_description": "string",
      "opt_in_process_description": "string",
      "start_message": "string",
      "help_message": "string",
      "stop_message": "string",
      "sample_messages": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z"
    }
  },
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "doc_url": "string"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "version": "string"
  }
}
Empty
Empty
{
  "success": true,
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "doc_url": "string"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "version": "string"
  }
}
{
  "success": true,
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "doc_url": "string"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "version": "string"
  }
}

Delete a sender profile DELETE

Deletes one of your sender profiles and returns `204`. The delete is **soft**: the profile stops being usable and stops appearing in reads, and its message history is kept, because deleting a profile must not delete the record of what it sent. ## What it releases Anything the profile still held goes with it. A **phone number** returns to our inventory and can be given to whoever asks next — it does not stay reserved for you, and getting the same number back afterwards is not something we can promise. A **WhatsApp account of its own** is deregistered from Meta. Its routing rules stop being used, so nothing sends through the profile after this call. A profile that only inherits from its organization holds nothing of its own and releases nothing.

List your SMS markets GET

Every market you send SMS in, each with its sender, where that sender stands, and what its compliance holds. The same entries `GET /v3/channels` reports under `sms`, and the same shape `GET /v3/channels/sms/{country}/{type}` returns for one of them — so a list, a member read and the all-channels read cannot describe a market differently. Send `x-profile-id` with an organization key to list one of your profiles' markets.