ChannelManagerRpc

The ChannelManagerRpc endpoint group provides RPC methods for managing channel configurations, preparing provider setup flows, listing workflow references, and retrieving the public web chat widget configuration. It also exposes data retrieval with workflow-name enrichment for channel records.

Endpoints

POST /api/rpc (Method: ChannelManagerRpc.getData)

• Description: Retrieves channel configurations for the current subscription and enriches any linked workflow IDs with workflow names.
• Request Body:

{
  "method": "ChannelManagerRpc.getData",
  "params": {
    "filter": {},
    "sort": {},
    "page": 1,
    "pageSize": 100
  }
}

• Parameters:

• Response:

{
  "success": true,
  "data": {
    "data": [
      {
        "_id": "string",
        "inboundWorkflowId": "string",
        "inboundWorkflowIdDisplay": "string",
        "inboundSmsWorkflowId": "string",
        "inboundSmsWorkflowIdDisplay": "string",
        "inboundVoiceWorkflowId": "string",
        "inboundVoiceWorkflowIdDisplay": "string"
      }
    ],
    "totalCount": 0
  }
}

The response preserves the paginated shape returned by the underlying channel configuration listing and adds ...Display fields when linked workflow IDs are present. If a referenced workflow cannot be found, the corresponding display value is set to Invalid Workflow.

• Example (cURL):

curl -X POST "${APP_BASE_URL}/api/rpc" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "ChannelManagerRpc.getData",
    "params": {
      "page": 1,
      "pageSize": 100
    }
  }'

POST /api/rpc (Method: ChannelManagerRpc.setupProvider)

• Description: Handles interactive, multi-step setup for a channel provider.
• Request Body:

{
  "method": "ChannelManagerRpc.setupProvider",
  "params": {
    "providerName": "whatsapp_business_api",
    "command": "wizard_start",
    "args": {}
  }
}

• Parameters:

• Response:

{
  "success": true,
  "data": {}
}

The method returns whatever the provider-specific setup handler returns. The exact payload depends on the registered provider and setup command.

• Example (cURL):

curl -X POST "${APP_BASE_URL}/api/rpc" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "ChannelManagerRpc.setupProvider",
    "params": {
      "providerName": "whatsapp_business_api",
      "command": "wizard_start",
      "args": {}
    }
  }'

POST /api/rpc (Method: ChannelManagerRpc.create)

• Description: Creates a new channel configuration.
• Request Body:

{
  "method": "ChannelManagerRpc.create",
  "params": {
    "name": "Main Support Line",
    "channelType": "sms",
    "provider": "twilio"
  }
}

• Parameters:

The request schema is derived from OmniChannelConfigSchema with _id, createdAt, updatedAt, subscriptionId, and status removed, then made partial. That means the endpoint accepts a partial channel configuration object rather than requiring every field from the base schema.

• Response:

{
  "success": true,
  "data": {}
}

The method returns the created channel configuration as produced by the underlying service. The exact persisted fields and any generated values depend on service-side logic.

• Example (cURL):

curl -X POST "${APP_BASE_URL}/api/rpc" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "ChannelManagerRpc.create",
    "params": {
      "name": "Main Support Line",
      "channelType": "sms",
      "provider": "twilio"
    }
  }'

POST /api/rpc (Method: ChannelManagerRpc.delete)

• Description: Deletes a channel configuration.
• Request Body:

{
  "method": "ChannelManagerRpc.delete",
  "params": {
    "_id": "string"
  }
}

• Parameters:

• Response:

{
  "success": true,
  "data": {}
}

The method returns whatever the underlying service returns for deletion.

• Example (cURL):

curl -X POST "${APP_BASE_URL}/api/rpc" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "ChannelManagerRpc.delete",
    "params": {
      "_id": "507f1f77bcf86cd799439011"
    }
  }'

POST /api/rpc (Method: ChannelManagerRpc.update)

• Description: Updates an existing channel configuration.
• Request Body:

{
  "method": "ChannelManagerRpc.update",
  "params": {
    "_id": "string",
    "name": "Updated Name"
  }
}

• Parameters:

The request schema is derived from OmniChannelConfigSchema.partial().extend({ _id: z.string() }), so the payload accepts any partial channel configuration fields plus the required _id.

• Response:

{
  "success": true,
  "data": {}
}

The method returns whatever the underlying service returns after applying the update.

• Example (cURL):

curl -X POST "${APP_BASE_URL}/api/rpc" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "ChannelManagerRpc.update",
    "params": {
      "_id": "507f1f77bcf86cd799439011",
      "name": "Updated Name"
    }
  }'

POST /api/rpc (Method: ChannelManagerRpc.initiateWhatsAppSetup)

• Description: Initiates the setup process for a new WhatsApp channel, generating a temporary setup ID and verification token.
• Request Body:

{
  "method": "ChannelManagerRpc.initiateWhatsAppSetup",
  "params": {}
}

• Parameters:

No parameters are required.

• Response:

{
  "success": true,
  "data": {}
}

The method returns whatever the underlying service returns when starting the WhatsApp setup flow. The source confirms that this RPC delegates to ChannelManagerService.initiateWhatsAppSetup(context).

• Example (cURL):

curl -X POST "${APP_BASE_URL}/api/rpc" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "ChannelManagerRpc.initi