Channels

This section of the Notify.Events API documentation describes methods for managing channels.


Show List

Returns a list of your channels and their parameters.

Request:

POST /channels

{
    "limit": 10,                                //   integer    Number of records requested
    "offset": 0                                 //   integer    Offset from start
}

Response:

{
    "total": 2,                                 //   integer    Total records
    "items": [
        {
            "id": 500,                          //   integer    Channel ID
            "title": "My first channel",        //   string     Channel name
            "group": "Experimental",            //   string     Channel group
            "created_at": 1622505600,           //   integer    Created on (unixtime)
            "updated_at": 1622505600            //   integer    Modified on (unixtime)
        },
        ...
    ]
}

View

Returns the parameters of the specified channel.

Request:

POST /channel/<channel_id>

Response:

{
    "id": 500,                                  //   integer    Channel ID
    "title": "My first channel",                //   string     Channel name
    "group": "Experimental",                    //   string     Channel group
    "token": "xxxxxxxx",                        //   string     Channel subscription token
    "public_subscribe": true,                   //   boolean    Public subscription available for the chhannel
    "payment_chats": [                          //              Prepaid chats available for the chhannel
        "sms"                                   //   string     Chat ID
    ],
    "chat_auths": [                             //              Integrations available for the channel
        {
            "chat_sn": "twilio",                //   string     Chat ID
            "chat_auth_id": 12                  //   integer    Integration ID
        },
        ...
    ],
    "created_at": 1622505600,                   //   integer    Created on (unixtime)
    "updated_at": 1622505600                    //   integer    Modified on (unixtime)
}

Create

Creates a channel.

Request:

POST /channel/create

{
    "title": "My first channel",                // * string     Channel name
    "group": "Experimental",                    //   string     Channle group
    "public_subscribe": true,                   //   boolean    Public subscription available for the channel
    "payment_chats": [                          //              Prepaid chats available for the channel
        "sms"                                   // * string     Chat ID
    ],
    "chat_auths": [                             //              Integrations available for the channel
        {
            "chat_sn": "twilio",                // * string     Chat ID
            "chat_auth_id": 12                  // * integer    Integration ID
        },
        ...
    ]
}

Response:

{
    "id": 500,                                  //   integer    Channel ID
    "title": "My first channel",                //   string     Channel name
    "group": "Experimental",                    //   string     Channel group
    "token": "xxxxxxxx",                        //   string     Channel subscription token
    "public_subscribe": true,                   //   boolean    Public subscription available for the channel
    "payment_chats": [                          //              Prepaid chats available for the channel
        "sms"                                   //   string     Chat ID
    ],
    "chat_auths": [                             //              Integrations available for the channel
        {
            "chat_sn": "twilio",                //   string     Chat ID
            "chat_auth_id": 12                  //   integer    Intagration ID
        },
        ...
    ],
    "created_at": 1622505600,                   //   integer    Created on (unixtime)
    "updated_at": 1622505600                    //   integer    Modified on (unixtime)
}

Update

Updates the parameters of the specified channel.

Request:

POST /channel/<channel_id>/update

{
    "title": "My first channel",                // * string     Channel ID
    "group": "Experimental",                    //   string     Channel group
    "public_subscribe": true,                   //   boolean    Public subscription available for the channel
    "payment_chats": [                          //              Prepaid chats available for the channel
        "sms"                                   // * string     Chat ID
    ],
    "chat_auths": [                             //              Integrations available for the channel
        {
            "chat_sn": "twilio",                // * string     Chat ID
            "chat_auth_id": 12                  // * integer    Integration ID
        },
        ...
    ]
}

Delete

Removes the specified channel.

Request:

POST /channel/<channel_id>/delete