UpdateInboundSmsGroup

POST

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

Update a InboundSmsGroup defined by UpdateInboundSmsGroupReq message for
the specified sms_group_id, region_id and org_id
will update the following
inbound sms group fields:
TemplateId
SmsNumber
The method will return a UpdateInboundSmsGroupRes message with true or false .
Required permissions: VIEW_SMS

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "inbound_sms_group_id": "string",
    "sms_number_sid": 0,
    "name": "string",
    "status": "IB_SMS_GROUP_UNKNOWN",
    "start_time": "1s",
    "stop_time": "1s",
    "total_cost": 0,
    "inbound_sms_template_id": "string",
    "report_settings": {
        "enabled": true,
        "delivery_method": "string",
        "report_template_sid": 0,
        "sms_settings": {
            "phone_numbers": [
                "string"
            ],
            "src_number": "string"
        },
        "email_settings": {
            "report_type": "string",
            "email_addresses": [
                "string"
            ],
            "report_format": "string",
            "from_email_address": "string"
        },
        "ftp_settings": {
            "passwd": "string",
            "username": "string",
            "report_format": "string",
            "path": "string",
            "url": "string"
        },
        "sftp_settings": {
            "passwd": "string",
            "username": "string",
            "report_format": "string",
            "path": "string",
            "authentication_type": "string",
            "url": "string",
            "private_key": "string"
        }
    }
}

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/updateinboundsmsgroup' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inbound_sms_group_id": "string",
    "sms_number_sid": 0,
    "name": "string",
    "status": "IB_SMS_GROUP_UNKNOWN",
    "start_time": "1s",
    "stop_time": "1s",
    "total_cost": 0,
    "inbound_sms_template_id": "string",
    "report_settings": {
        "enabled": true,
        "delivery_method": "string",
        "report_template_sid": 0,
        "sms_settings": {
            "phone_numbers": [
                "string"
            ],
            "src_number": "string"
        },
        "email_settings": {
            "report_type": "string",
            "email_addresses": [
                "string"
            ],
            "report_format": "string",
            "from_email_address": "string"
        },
        "ftp_settings": {
            "passwd": "string",
            "username": "string",
            "report_format": "string",
            "path": "string",
            "url": "string"
        },
        "sftp_settings": {
            "passwd": "string",
            "username": "string",
            "report_format": "string",
            "path": "string",
            "authentication_type": "string",
            "url": "string",
            "private_key": "string"
        }
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "result": true
}

🟢200Success

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

CreateInboundSmsGroup

DeleteInboundSmsGroup