Fetch SMS Channels

Get SMS Channels

GET https://api.oneroute.io/api/public/channels/sms

Query Parameters

Name	Type	Description
status (Optional)	string	status of the channels to fetch. Must be ACTIVE , INACTIVE or PENDING
name (Optional)	string	name of the channel to fetch

Headers

Name	Type	Description
apikey*	string	API key

200

{
    "data": [
        {
            "id": "553e8ec2-bdc2-4b01-b6bf-eb07fa640218",
            "phone": null,
            "identifier": "OneRoute SMS",
            "medium": "SMS",
            "credentials": null,
            "description": "SMS Channel",
            "name": "OneRoute SMS",
            "type": "CUSTOM",
            "country": "NG",
            "status": "ACTIVE",
            "createdAt": "2021-08-04T12:32:11.543Z",
            "updatedAt": "2021-08-04T12:32:11.543Z",
            "firm_id": "e9e46626-0093-4bf6-a657-2a824567d801",
            "provider_config_id": "d2fd2feb-06dc-4787-ae3e-dbeb20e184d2"
        }
    ],
    "message": "Chanels fetched successfully",
    "success": true
}

401

{
    "data": null,
    "message": "Invalid API Key",
    "success": false
}