OneRoute
  • Introduction
  • Prerequisites
  • Whatsapp API
    • Sandbox (Test API Key)
    • Getting Started
    • Endpoints
      • Fetch Channels
      • Fetch Channel Templates
      • Send Template Message
      • Send Campaign Message
      • Send Session Message
    • FAQ
  • EMAIL API
    • Getting Started
    • Endpoints
      • Fetch Email Channels
      • Send Email to Customers
  • SMS API
    • Getting Started
    • Endpoints
      • Fetch SMS Channels
      • Send SMS to Customers
      • Send OTP SMS to Customers
      • Fetch SMS Messages
      • Get SMS DLR Message
  • ONEOTP API
    • Getting Started
    • Endpoints
      • Fetch OTP Templates
      • Send OTP
      • Verify OTP
  • EMBED
    • Getting Started
    • Installation
    • Push Notification
  • OTHERS
    • Receiving Events - Webhooks
    • Fetch Channel By Id
    • Fetch Logs
Powered by GitBook
On this page

Was this helpful?

  1. OTHERS

Fetch Channel By Id

Get Channel By Id

GET https://api.oneroute.io/api/public/channel/:id

This endpoint allows you to fetch a channel by its ID.

Path Parameters

Name
Type
Description

id

string

id of the channel to fetch.

Headers

Name
Type
Description

apiKey

string

API Key for authentication.

{
    "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": "channel fetched successfully",
    "success": true
}
{
    "data": null,
    "message": "Invalid API Key",
    "success": false
}
{
    "data": null,
    "message": "channel not found",
    "success": false
}
PreviousReceiving Events - WebhooksNextFetch Logs

Last updated 3 years ago

Was this helpful?