Webex Interact

https://docs.webexinteract.com
Admin
Webex Interact is a platform designed for managing and sending customer communications, including...
Tokens:47,697
Snippets:516
Trust Score:5.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Shortlink response examples

Source: https://docs.webexinteract.com/reference/shortlinks-api

Examples of successful and error responses for the GET shortlink endpoint.

```json
{
  "title": "Webex Interact Website- Retail Usecase",
  "link_id": "shl_393RQ5L8U1YZpPdrJPUImK2Gdng",
  "target_url": "https://webexinteract.com/use-cases/retail",
  "short_link_url": "https://sh.l.imireach.net/HoaB98",
  "tags": [
    "Usecases",
    "Retail"
  ],
  "created_at": "2025-10-14T11:10:50Z",
  "track_clicks": true
}
```

```json
{
  "trace_id": "da016c7952e0d910",
  "code": "ERR_AST_NF_003",
  "error": "RESOURCE_NOT_FOUND",
  "message": "Short link with identifier 'shl_343RQ5L8U1YJpPdrJPUImK2Gdna' not found",
  "status": 404,
  "timestamp": "2025-10-15T13:16:02.190564392Z"
}
```

--------------------------------

### API Response Examples

Source: https://docs.webexinteract.com/reference/lists-api

Examples of successful list retrieval and various validation error responses.

```json
{
  "paging": {
    "current_page": 1,
    "total_items": 3,
    "total_pages": 1
  },
  "items": [
    {
      "uid": "LST_99e604it00wHpm1LgPbBpJ4bITb",
      "name": "alist",
      "created_at": "2025-07-31T15:24:25Z",
      "updated_at": "2025-07-31T15:24:25Z"
    },
    {
      "uid": "LST_99e5yCpwsnl5p36C1y14AK5k3JY",
      "name": "alistname",
      "created_at": "2025-07-31T15:24:10Z",
      "updated_at": "2025-07-31T15:24:10Z"
    },
    {
      "uid": "LST_99duL5cOmHKBhLqwhI9KYkSrngI",
      "name": "Calisto",
      "created_at": "2025-07-31T13:48:31Z",
      "updated_at": "2025-07-31T13:51:26Z"
    }
  ]
}
```

```json
{
  "trace_id": "dac476ae8714815f",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-08-04T15:03:41.672018023Z",
  "validation_errors": [
    {
      "field": "filter.sortOrder",
      "message": "sorting.order.generic",
      "rejected_value": "ASCs"
    }
  ]
}
```

```json
{
  "trace_id": "4caa751ed70540d4",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-08-04T15:01:16.574302643Z",
  "validation_errors": [
    {
      "field": "filter.sortBy",
      "message": "sorting.by.generic",
      "rejected_value": "exampleitemdoesnotexist"
    }
  ]
}
```

```json
{
  "trace_id": "f9d73f7eacdf93e4",
  "code": "ERR_CNT_VAL_004",
  "error": "INVALID_FORMAT",
  "message": "Invalid format for field 'page_size'. Expected format: int",
  "status": 400,
  "timestamp": "2025-08-04T15:04:59.809053718Z",
  "validation_errors": null
}
```

```json
{
  "trace_id": "1c9d567be53781b5",
  "code": "ERR_CNT_VAL_004",
  "error": "INVALID_FORMAT",
  "message": "Invalid format for field 'page_number'. Expected format: int",
  "status": 400,
  "timestamp": "2025-08-04T15:08:04.733230910Z",
  "validation_errors": null
}
```

--------------------------------

### Query senders response examples

Source: https://docs.webexinteract.com/reference/senders-api

Example responses for successful queries and common validation errors regarding page size.

```json
{
  "paging": {
    "current_page": 1,
    "total_items": 24,
    "total_pages": 24
  },
  "items": [
    {
      "id": "ssd_1zgeYliRwjSVJVw2h1uDlloIGcr",
      "name": "mytestabc",
      "status": "Verified"
    }
  ]
}
```

```json
{
  "trace_id": "29faaedea3465268",
  "errors": [
    {
      "message": "must be greater than 0",
      "field": "get_all_sms_senders.page_size"
    }
  ]
}
```

```json
{
  "trace_id": "b2c94535584d96f4",
  "errors": [
    {
      "message": "must be less than or equal to 100",
      "field": "get_all_sms_senders.page_size"
    }
  ]
}
```

--------------------------------

### Filter response examples

Source: https://docs.webexinteract.com/reference/shortlinks-api

Examples of successful and error responses for the POST filter endpoint.

```json
{
  "paging": {
    "current_page": 1,
    "total_items": 1,
    "total_pages": 5
  },
  "items": [
    {
      "title": "Feedback Form Link",
      "link_id": "shl_33n8uU7jy1PQCusVTw9yq3gyav3",
      "target_url": "http://imimobile.atlassian.net/browse/RCH-*",
      "short_link_url": "https://sh.l.imireach.net/mUF",
      "tags": [
        "tag-0tag-0tag-0tag",
        "tag-1"
      ],
      "created_at": "2025-10-08T16:41:37Z",
      "track_clicks": false
    }
  ]
}
```

```json
{
  "trace_id": "842c2c9bab450d70",
  "code": "ERR_AST_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-10-24T09:59:18.537761005Z",
  "validation_errors": [
    {
      "field": "sort.sort_order",
      "message": "Sort Order must be ASC or DESC",
      "rejected_value": "DESCa"
    }
  ]
}
```

--------------------------------

### Create list response examples

Source: https://docs.webexinteract.com/reference/lists-api

JSON responses for successful list creation and validation errors.

```json
{
  "uid": "LST_30pKUMCzHT0yoe9r5reNFqRqc6a",
  "name": "alistname"
}
```

```json
{
  "trace_id": "c7ac82ee91e8152e",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-08-04T15:11:58.515539363Z",
  "validation_errors": [
    {
      "field": "name",
      "message": "Invalid list name",
      "rejected_value": "doingalistoverapidoingalistoverapidoingalistoverapidoingalistoverapidoingalistoverapidoingalistoverapidoingalistoverapido"
    }
  ]
}
```

--------------------------------

### Query contacts list request

Source: https://docs.webexinteract.com/reference/contacts-api

Example of a GET request to retrieve contacts from a specific list with pagination parameters.

```curl
GET https://api.webexinteract.com/contacts/v1/contacts/list/LST_099uL5cOmHKBhLqwhI9KYkSrngI?page_number=1&page_size=2
```

--------------------------------

### SMS API Test Response Examples

Source: https://docs.webexinteract.com/reference/sms-api

Examples of JSON responses returned by the test endpoint, including success, partial success, and error scenarios.

```json
[
  {
    "request_id": "aps_34gwaass6GrNQZWosCYunS7Dw3j",
    "messages": [
      {
        "transaction_id": null,
        "to": "+447700900001",
        "status": "validated",
        "code": 1003
      }
    ],
    "errors": []
  },
  {
    "request_id": "aps_1abcdefgH2IjklMnOpQrStUvWxYz",
    "messages": [
      {
        "transaction_id": null,
        "to": "+447700900002",
        "status": "validated",
        "code": 1003
      }
    ],
    "errors": []
  },
  {
    "request_id": "aps_9xYzWvU7tSrQpOnMlKjIhGfEdCbA",
    "messages": [
      {
        "transaction_id": null,
        "to": "+447700900003",
        "status": "validated",
        "code": 1003
      }
    ],
    "errors": []
  }
```

```json
{
  "request_id": "aps_34h3h0rtc1UEtusUam5iMf76Lof",
  "messages": [
    {
      "transaction_id": null,
      "to": "+447800000001",
      "status": "validated",
      "code": 1003
    }
  ],
  "errors": [
    {
      "to": "+447700900002",
      "status": "error",
      "code": 1002,
      "message": "Invalid phone number or unsupported region or invalid phone number for country code."
    },
    {
      "to": "+447700900003",
      "status": "error",
      "code": 1002,
      "message": "Invalid phone number or unsupported region or invalid phone number for country code."
    }
  ]
}
```

```json
{
  "trace_id": "c442zzb402b1b6c7",
  "errors": [
    {
      "field": null,
      "message": "insufficient balance.",
      "code": 10005
    }
  ]
}
```

--------------------------------

### Account metadata response structure

Source: https://docs.webexinteract.com/reference/account-api

Example of a successful 200 response containing account details.

```json
{
  "account_uid": "acc_2Qpy74qWGaBcDeFBEXa72L",
  "account_status": "VERIFIED",
  "home_region": "UK",
  "time_zone": "en_GB",
  "default_currency": "GBP",
  "account_balance": 1000,
  "created": "2024-07-19T15:28:58Z"
}
```

--------------------------------

### GET /optouts/

Source: https://docs.webexinteract.com/reference/opt-outs-api

Query the opt-outs on an account, with optional filtering and paging.

```APIDOC
## GET /optouts/

### Description
Query the opt-outs on an account, with optional filtering and paging.

### Method
GET

### Endpoint
/optouts/
```

--------------------------------

### Create an opt-out request

Source: https://docs.webexinteract.com/reference/opt-outs-api

Examples of JSON request bodies for account-level and asset-level opt-outs.

```json
{
  "optouts": [
    {
      "number": "447807127121"
    }
  ]
}
```

```json
{
  "optouts": [
    {
      "number": "447807127122",
      "channel": "sms",
      "asset_id": "num_3DNr8KIVDwMtQKYtYvRtQCXbc5x"
    }
  ]
}
```

```json
{
  "optouts": [
    {
      "number": "447807127122",
      "channel": "whatsapp",
      "asset_id": "wbp_2k8U5Sdg3fM615QpOvEgzFiJZ1C"
    }
  ]
}
```

--------------------------------

### Shortlink API Responses

Source: https://docs.webexinteract.com/reference/shortlinks-api

Example responses for successful creation and validation failure scenarios.

```json
{
  "title": "Webex Interact Website- Retail Usecase",
  "link_id": "shl_33n2I2tiKU3ISIXKtZcbS8f4uAd",
  "target_url": "https://webexinteract.com/use-cases/retail",
  "short_link_url": "https://sh.l.imireach.net/lAa",
  "tags": [
    "Usecases",
    "Retail"
  ],
  "created_at": "2025-10-08T21:17:12Z",
  "track_clicks": false
}
```

```json
{
  "trace_id": "cafc8acb8587b77f",
  "code": "ERR_AST_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-10-24T09:30:45.075326154Z",
  "validation_errors": [
    {
      "field": "tags[]",
      "message": "Invalid tag.",
      "rejected_value": "tag-01234567890123456789123456789"
    }
  ]
}
```

--------------------------------

### Scheduled Messages API Response Examples

Source: https://docs.webexinteract.com/reference/scheduled-messages-api

Examples of successful retrieval of scheduled messages and a validation error response.

```json
{
  "paging": {
    "current_page": 1,
    "total_items": 4,
    "total_pages": 1
  },
  "items": [
    {
      "id": "aps_76NFW8JbqqWOoTZln2t4wQUIqBr",
      "sender_name": "MattCo",
      "created_at": "2025-12-04T09:05:50Z",
      "scheduled_at": "2025-12-15T16:09:17Z",
      "type": "API",
      "status": "SCHEDULED",
      "api_project_name": "My API Project"
    },
    {
      "id": "aps_36bcIAIlR4QRPLl1hmPd5sO8U6A",
      "sender_name": "MattCo",
      "created_at": "2025-12-09T11:10:28Z",
      "scheduled_at": "2025-12-18T02:20:20Z",
      "type": "API",
      "status": "SCHEDULED",
      "api_project_name": "My API Project",
      "estimated_cost": 0.039
    },
    {
      "id": "aps_36bdYov9dRLE8PNRHM0xSwpme61",
      "sender_name": "+447800000000",
      "created_at": "2025-12-09T11:20:55Z",
      "scheduled_at": "2025-12-18T02:20:20Z",
      "type": "API",
      "status": "SCHEDULED",
      "api_project_name": "My Other API Project",
      "estimated_cost": 0.039
    },
    {
      "id": "cmp_36bze7d9BObohgoE2t4maNdo7BT",
      "name": "Quick Send: 09 December 2025, 02:23:39pm",
      "sender_name": "51234",
      "created_at": "2025-12-09T14:25:18Z",
      "scheduled_at": "2025-12-31T17:00:00Z",
      "type": "CAMPAIGN",
      "status": "DELETED",
      "estimated_cost": 0.078
    }
  ]
}
```

```json
{
  "trace_id": "ba98346734297a6a",
  "code": "ERR_CMP_VAL_012",
  "error": "VALIDATION_ERROR",
  "message": "At least one of the following must be provided: id, created_at (start/end), or scheduled_at (start/end)",
  "status": 400,
  "timestamp": "2025-12-10T14:27:43.435478549Z",
  "validation_errors": null
}
```

--------------------------------

### API Response Examples

Source: https://docs.webexinteract.com/reference/contacts-api

A collection of successful and error-based API responses for contact operations.

```json
{
  "list_id": "LST_30duL5cOmHKBhLqwhI9KYkSrngI",
  "list_name": "a list for deletion",
  "message": "Contact request has been queued successfully",
  "code": "SUCCESS_CNT_GEN_001"
}
```

```json
{
  "trace_id": "ca20fed9fb6ed529",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-08-06T15:33:19.398194146Z",
  "validation_errors": [
    {
      "field": "createContacts.request.conCreateRequests[0]",
      "message": "message = Invalid request: either 'phone_number' or 'whatsapp_number' must be provided for a contact.",
      "rejected_value": {
        "title": "Mrs",
        "company_name": "RobelBorert",
        "date_of_birth": "Fri Jul 23 14:05:57 BST 1965",
        "city": "Worcester",
        "state": "Worcestershire",
        "zip": "WR1 1AA",
        "country": "GB",
        "alternate_phone": "+447807123000",
        "email_address": "exampleemail123@something.com",
        "firstname": "Rupert",
        "lastname": "Neve",
        "address_1": "123 Example Road",
        "address_2": "Someplace"
      }
    }
  ]
}
```

```json
{
  "trace_id": "0433562ca75f1ede",
  "code": "ERR_CNT_VAL_001",
  "error": "BAD_REQUEST",
  "message": "List not found",
  "status": 400,
  "timestamp": "2025-08-06T15:36:09.970766521Z",
  "validation_errors": null
}
```

```json
{
  "trace_id": "0e696d657487d3a2",
  "code": "ERR_CNT_VAL_001",
  "error": "INVALID_UID_FORMAT",
  "message": "Invalid UID format: 'LST_30duL5cOmHKBhLqwhI9KYkSrngIa'. UIDs must follow the specified format.",
  "status": 400,
  "timestamp": "2025-08-06T15:37:34.496861680Z",
  "validation_errors": [
    {
      "field": "createContacts.request.listUid",
      "message": "Invalid UID provided. LST_30duL5cOmHKBhLqwhI9KYkSrngIa",
      "rejected_value": "LST_30duL5cOmHKBhLqwhI9KYkSrngIa"
    }
  ]
}
```

```json
{
  "trace_id": "13ad4810c3cd4e8f",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-08-06T15:38:03.752336373Z",
  "validation_errors": [
    {
      "field": "createContacts.request.phoneRegion",
      "message": "Invalid phone number region code.",
      "rejected_value": "GBa"
    }
  ]
}
```

```json
{
  "trace_id": "9591951b5c355631",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-08-06T15:39:15.056218665Z",
  "validation_errors": [
    {
      "field": "createContacts.request.mergeType",
      "message": "Invalid merge_type. Allowed values: skipDuplicates, allowDuplicates, mergeByPhoneNumberInList, mergeByWhatsappIdInList.",
      "rejected_value": "mergeByPhoneNumberInLista"
    }
  ]
}
```

--------------------------------

### Delete list response examples

Source: https://docs.webexinteract.com/reference/lists-api

HTTP and JSON responses for list deletion outcomes.

```http
HTTP/1.1 204 No Content
```

```json
{
  "trace_id": "7351705e38f343ce",
  "code": "ERR_CNT_VAL_001",
  "error": "INVALID_UID_FORMAT",
  "message": "Invalid UID format: 'LST_30p2v1LIePstioxO365fKuj1KYZa'. UIDs must follow the specified format.",
  "status": 400,
  "timestamp": "2025-08-04T15:14:37.040365244Z",
  "validation_errors": [
    {
      "field": "deleteList.uid",
      "message": "Invalid UID provided. LST_30p2v1LIePstioxO365fKuj1KYZa",
      "rejected_value": "LST_30pMv1LIePstioxO365fKuj1KYZa"
    }
  ]
}
```

--------------------------------

### Query opt-outs via cURL

Source: https://docs.webexinteract.com/reference/opt-outs-api

Example request to retrieve opt-outs filtered by type and page size.

```curl
GET https://api.webexinteract.com/contacts/v1/optouts?opt_out_type=keyword&page_size=10
```

--------------------------------

### Successful Opt-Out Responses

Source: https://docs.webexinteract.com/reference/opt-outs-api

Examples of 201 Created responses for account-level and asset-level opt-out requests.

```json
{
  "total_submitted": 1,
  "total_succeeded": 1,
  "total_failed": 0,
  "items": [
    {
      "number": "+447807127121",
      "channel": "SMS",
      "status": "success",
      "message": "Successfully opted out at account level for SMS",
      "account_level_opt_out": true,
      "opt_out_type": "api_import",
      "opt_out_time": "2026-05-28T12:01:29Z"
    }
  ]
}
```

```json
{
  "total_submitted": 1,
  "total_succeeded": 1,
  "total_failed": 0,
  "items": [
    {
      "number": "+447807127122",
      "channel": "SMS",
      "status": "success",
      "message": "Successfully opted out for asset num_3DNr8KIVDwMtQKYtYvRtQCXbc5x",
      "account_level_opt_out": false,
      "opt_out_type": "api_import",
      "opt_out_time": "2026-05-28T12:00:46Z"
    }
  ]
}
```

--------------------------------

### Query contacts list responses

Source: https://docs.webexinteract.com/reference/contacts-api

Examples of successful and error responses for the contacts list retrieval endpoint.

```json
{
  "paging": {
    "current_page": 1,
    "total_items": 2,
    "total_pages": 1
  },
  "items": [
    {
      "zip": "AB11 6AA",
      "country": "GB",
      "firstname": "Matt",
      "whatsapp_id": "+447878805000",
      "field_3": null,
      "city": "Port Hiram",
      "date_of_birth": "Sun May 27 07:23:57 BST 1979",
      "address_1": "456 Aroad",
      "field_1": null,
      "address_2": "Aplace",
      "field_2": null,
      "created_at": "2025-08-06 13:13:16",
      "phone_region": "GB",
      "title": "Dr",
      "lastname": "Jones",
      "uid": "CON_30umnHdxDUKZ0VJSPeefhXWzdYr",
      "email_address": "anotheremail@somedomain.com",
      "updated_at": null,
      "company_name": "MJ CO",
      "whatsapp_region": "GB",
      "phone_number": "+447879040000",
      "alternate_phone": null,
      "state": "Shropshire"
    },
    {
      "zip": "WR1 1AA",
      "country": "GB",
      "firstname": "Rupert",
      "whatsapp_id": "+447878802000",
      "field_3": null,
      "city": "Worcester",
      "date_of_birth": "Fri Jul 23 14:05:57 BST 1965",
      "address_1": "123 Example Road",
      "field_1": null,
      "address_2": "Someplace",
      "field_2": null,
      "created_at": "2025-08-06 13:13:16",
      "phone_region": "GB",
      "title": "Mrs",
      "lastname": "Neve",
      "uid": "CON_30umnChxDkTubfkSoDo31YwyGOI",
      "email_address": "exampleemail123@something.com",
      "updated_at": null,
      "company_name": "RobelBorert",
      "whatsapp_region": "GB",
      "phone_number": "+447807121000",
      "alternate_phone": null,
      "state": "Worcestershire"
    }
  ]
}
```

```json
{
  "trace_id": "57bd01a3ef6be70e",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-08-06T13:17:49.076588217Z",
  "validation_errors": [
    {
      "field": "search.pageSize",
      "message": "page.size.generic",
      "rejected_value": 0
    }
  ]
}
```

```json
{
  "trace_id": "264a088488950a54",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-08-06T13:21:38.151611848Z",
  "validation_errors": [
    {
      "field": "search.fields[3].<list element>",
      "message": "Contact retrieval field is invalid.",
      "rejected_value": "a"
    }
  ]
}
```

```json
{
  "trace_id": "9a5d8f5b6023d041",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Contact fields are missing from the request.",
  "status": 400,
  "timestamp": "2025-08-06T13:24:15.982073398Z",
  "validation_errors": null
}
```

--------------------------------

### Sample request

Source: https://docs.webexinteract.com/reference/contacts-api

A standard request body for creating contacts, including contact details, list ID, and merge configuration.

```json
{
  "contacts": [
    {
      "phone_number": "+447807121000",
      "whatsapp_number": "+447878802000",
      "title": "Mr",
      "company_name": "RND",
      "date_of_birth": "July 31, 1926",
      "city": "Newton Abbot",
      "state": "Devon",
      "zip": "TQ12 1AA",
      "country": "GB",
      "alternate_phone": "+447807123000",
      "email_address": "exampleemail123@something.com",
      "firstname": "Rupert",
      "lastname": "Neve",
      "address_1": "123 Example Road",
      "address_2": "Newton Abbot"
    },
    {
      "phone_number": "+447879040000",
      "whatsapp_number": "+447878805000",
      "title": "Dr",
      "company_name": "MJ CO",
      "date_of_birth": "Sun May 27 07:23:57 BST 1979",
      "city": "Port Hiram",
      "state": "Shropshire",
      "zip": "AB11 6AA",
      "country": "GB",
      "alternate_phone": "+447874276000",
      "email_address": "anotheremail@somedomain.com",
      "firstname": "Matt",
      "lastname": "Jones",
      "address_1": "456 Aroad",
      "address_2": "Aplace"
    }
  ],
  "list_id": "LST_90duL5cOmHKZhLqwhI9KYkSrnzI",
  "phone_region": "GB",
  "merge_type": "mergeByPhoneNumberInList",
  "callback_url": "https://somereceiver.site/0a316f99-a699-4a7f-a333-8b7f55499999",
  "correlation_id": "example correlation id"
}
```

--------------------------------

### Define a Utility Message Template Structure

Source: https://docs.webexinteract.com/docs/utility-templates-handbook

A sample structure for a utility message template, demonstrating the use of placeholders for dynamic content.

```css
Header:
📌 Appointment Reminder 🕒

Body:
Hi ${1},

This is a reminder about your upcoming appointment:

📅 Date: ${2}
⏰ Time: ${3}
📍 Location: ${4}

If you have any questions, please contact us.

Footer:
Thank you for choosing us! We look forward to seeing you soon.
```

--------------------------------

### POST /optouts/

Source: https://docs.webexinteract.com/reference/opt-outs-api

Create one or more opt-outs at account or asset level.

```APIDOC
## POST /optouts/

### Description
Create one or more opt-outs at account or asset level.

### Method
POST

### Endpoint
/optouts/
```

--------------------------------

### GET https://api.webexinteract.com/identity/v1/account

Source: https://docs.webexinteract.com/reference/account-api

Retrieves metadata about the authenticated account.

```APIDOC
## GET https://api.webexinteract.com/identity/v1/account

### Description
Retrieves metadata about your account, including status, region, and balance.

### Method
GET

### Endpoint
https://api.webexinteract.com/identity/v1/account

### Response
#### Success Response (200)
- **account_uid** (string) - Unique ID of the account
- **account_status** (string) - Trial, Verified Limited, or Verified status
- **home_region** (string) - The locale of the account
- **time_zone** (string) - The timezone of the account
- **default_currency** (string) - The account's default currency
- **account_balance** (number) - The monetary credit balance available on the account
- **created** (string) - The date time that the account was created

#### Response Example
{
  "account_uid": "acc_2Qpy74qWGaBcDeFBEXa72L",
  "account_status": "VERIFIED",
  "home_region": "UK",
  "time_zone": "en_GB",
  "default_currency": "GBP",
  "account_balance": 1000,
  "created": "2024-07-19T15:28:58Z"
}
```

--------------------------------

### GET https://api.webexinteract.com/assets/v1/senders

Source: https://docs.webexinteract.com/reference/senders-api

Retrieve a paginated list of all senders on your account.

```APIDOC
## GET https://api.webexinteract.com/assets/v1/senders

### Description
Retrieve a list of senders associated with your account. Supports pagination via query parameters.

### Method
GET

### Endpoint
https://api.webexinteract.com/assets/v1/senders

### Parameters
#### Query Parameters
- **page_number** (integer) - Optional - Defaults to 1 page if not given. Use in conjunction with page_size to return a subset.
- **page_size** (integer) - Optional - Defaults to 25 items if not given. Determines the number of items returned per page.

### Response
#### Success Response (200)
- **paging** (object) - Paging metadata including current_page, total_items, and total_pages.
- **items** (array) - List of sender objects containing id, name, and status.
```

--------------------------------

### Define a marketing message template structure

Source: https://docs.webexinteract.com/docs/whatsapp-marketing-templates-handbook

Example structure for a marketing message including header, body with variables, footer, and buttons.

```css
Header:
🎉 Weekend Offer! 📅

Body:
Hi ${1},

As a valued customer, we're offering an exclusive [Discount/Deal] for a limited time only. 
Don't miss out on this opportunity to [Save/Experience]!

🔥 Special Offer: [{{2}}]
📅 Offer Expires: [{{3}}]

Footer: Thanks for being a part of [Your Company]!

Button:
[Visit Website]
[Call now]
```

--------------------------------

### Shortlink deletion responses

Source: https://docs.webexinteract.com/reference/shortlinks-api

Examples of successful and failed responses for the delete operation.

```http
HTTP/1.1 204 No Content
```

```json
{
  "trace_id": "38aif88c9bf38014",
  "code": "ERR_AST_VAL_001",
  "error": "INVALID_UID_FORMAT",
  "message": "Invalid UID format: 'a'. UIDs must follow the specified format.",
  "status": 400,
  "timestamp": "2025-10-24T10:00:59.563289168Z",
  "validation_errors": [
    {
      "field": "delete_short_link_by_id.id",
      "message": "UID is invalid",
      "rejected_value": "a"
    }
  ]
}
```

--------------------------------

### GET https://api.webexinteract.com/assets/v1/senders/{id}

Source: https://docs.webexinteract.com/reference/senders-api

Retrieve details for a specific sender by its unique ID.

```APIDOC
## GET https://api.webexinteract.com/assets/v1/senders/{id}

### Description
Retrieve the details of a specific sender using its unique identifier.

### Method
GET

### Endpoint
https://api.webexinteract.com/assets/v1/senders/{id}

### Response
#### Success Response (200)
- **id** (string) - Unique ID
- **name** (string) - Sender name
- **status** (string) - Pending (Awaiting internal review) or Verified (Approved for use)
```

--------------------------------

### Submitted Event Payload

Source: https://docs.webexinteract.com/reference/sms-api-request-accepted

Example JSON response received when a message is accepted for processing.

```json
//Sample response for a message submitted to operator
{
  "specversion": "1.0",
  "type": "com.interact.messages.sms.status",
  "source": "https://api.webexinteract.com/v1/sms",
  "id": "evt_2z01l2qZ8MRVmFZSUQHHfIjVvje",
  "time": "2025-06-25T12:08:43Z",
  "datacontenttype": "application/json",
  "data": {
    "status": "submitted",
    "channel": "sms",
    "code": "1003",
    "phone_number": "+447810000001",
    "from": "Name",
    "message_body": "This is your message",
    "message_parts": "1",
    "scheduled_at": "2025-06-30T12:08:43Z",
    "list_id": "LST_30pMyhWlE2KM55MCNJPh6CAIxvX",    
    "campaign_name": "My campaign",
    "campaign_id": "cmp_219r8u4981u498"
  },
  "correlation_id": "anexternallyassignedreference",
  "transaction_id": "tid_35T5b3cQmfqTu6jcedrdVcSmNHr"
}
```

--------------------------------

### Create a list

Source: https://docs.webexinteract.com/reference/lists-api

Sends a POST request to create a new contact list with a specified name.

```curl
POST https://api.webexinteract.com/contacts/v1/lists/create
```

--------------------------------

### Query senders with cURL

Source: https://docs.webexinteract.com/reference/senders-api

Retrieve a paginated list of senders using the GET method.

```curl
GET https://api.webexinteract.com/assets/v1/senders/?page_number=1&page_size=1
```

--------------------------------

### Failure Responses

Source: https://docs.webexinteract.com/reference/opt-outs-api

Examples of failure responses when a number is not found, invalid, or the request is malformed.

```json
{
  "total_submitted": 1,
  "total_succeeded": 0,
  "total_failed": 1,
  "items": [
    {
      "number": "+447807127123",
      "status": "failure",
      "message": "Number not found on SMS channel"
    }
  ]
}
```

```json
{
  "total_submitted": 1,
  "total_succeeded": 0,
  "total_failed": 1,
  "items": [
    {
      "number": "+447807127123",
      "status": "failure",
      "message": "Number not found for the specified SMS asset"
    }
  ]
}
```

```json
{
  "total_submitted": 1,
  "total_succeeded": 0,
  "total_failed": 1,
  "items": [
    {
      "number": "+447807127123a",
      "status": "failure",
      "message": "Invalid phone number. Number must be in E.164 format."
    }
  ]
}
```

```json
{
  "trace_id": "no-trace-id",
  "code": "ERR_CNT_VAL_001",
  "error": "MISSING_REQUIRED_FIELD",
  "message": "Required field 'numbers' is missing",
  "status": 400,
  "timestamp": "2026-05-28T15:43:26.377057543Z",
  "validation_errors": [
    {
      "field": "numbers",
      "message": "The numbers list must not be empty",
      "rejected_value": null
    }
  ]
}
```

```json
{
  "trace_id": "no-trace-id",
  "code": "ERR_CNT_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Channel mismatch: the specified asset does not match the requested channel",
  "status": 400,
  "timestamp": "2026-05-28T15:43:49.984931494Z",
  "validation_errors": null
}
```

```json
{
  "trace_id": "no-trace-id",
  "code": "ERR_CNT_REQ_002",
  "error": "INVALID_REQUEST_BODY",
  "message": "Invalid or malformed request body. Please check your JSON format and ensure all required fields are provided.",
  "status": 400,
  "timestamp": "2026-05-28T15:44:24.687216601Z",
  "validation_errors": null
}
```
Tokens:
Raw