ListSmsTasksByGroupSids

POST

https://api.cbf.tcn.com/api/v0alpha/smsapi/listsmstasksbygroupsids

List Sms Task defined by ListSmsTasksByGroupSidsReq message.
Gets all details for the array of group sids
The method will return a stream of ListSmsTasksByGroupSidsRes messages
containing delivery status, msg_time, cost
belonging to the smsgroup.
Required permissions: VIEW_SMS

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "sms_group_sids_arr": [
        0
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/smsapi/listsmstasksbygroupsids' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sms_group_sids_arr": [
        0
    ]
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "sms_task_info_with_reply": [
        {
            "sms_task_info_res": {
                "sms_task_sid": 0,
                "sms_group_sid": 0,
                "delivery_status": 0,
                "delivery_status_message": "string",
                "data": "string",
                "cost": 0,
                "msg_uuid": "string",
                "msg_time": "1s",
                "status": 0,
                "phone_num_col": "string",
                "units": 0,
                "sms_task_parent": "string",
                "mam_agent_response": {
                    "status": "QUEUED",
                    "agent_response_time": "1s",
                    "agent_name": "string"
                }
            },
            "sms_received_replies": [
                {
                    "sms_received_replies_sid": 0,
                    "sms_task_sid": 0,
                    "src_number": "string",
                    "dst_number": "string",
                    "msg_uuid": "string",
                    "received_reply": "string",
                    "received_time": "1s",
                    "analysis_report": "string",
                    "inbound_sms_group_id": "string",
                    "cost": 0,
                    "status": "IB_SMS_TASK_UNKNOWN",
                    "units": 0
                }
            ]
        }
    ]
}

🟢200Success

Modified at 2025-09-26 15:44:58

ListSmsGroupsByGroupSids

ListSmsGroupByFiltersForAudit