Outbound Set | SignalCore

import requests
url = "https://signalcore.ai/v1/channels/channel_id/outbound"
payload = {
    "username": "username",
    "password": "password"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

{
  "id": "id",
  "agent_id": "agent_id",
  "kind": "whatsapp",
  "provider": "provider",
  "name": "name",
  "external_id": "external_id",
  "address": "address",
  "outbound": true,
  "status": "pending",
  "detail": "detail",
  "settings": {
    "answers": true,
    "filter": "filter",
    "filter_keywords": [
      "filter_keywords"
    ],
    "hours": {
      "mon": [
        {
          "start": "start",
          "end": "end"
        }
      ],
      "tue": [
        {
          "start": "start",
          "end": "end"
        }
      ],
      "wed": [
        {
          "start": "start",
          "end": "end"
        }
      ],
      "thu": [
        {
          "start": "start",
          "end": "end"
        }
      ],
      "fri": [
        {
          "start": "start",
          "end": "end"
        }
      ],
      "sat": [
        {
          "start": "start",
          "end": "end"
        }
      ],
      "sun": [
        {
          "start": "start",
          "end": "end"
        }
      ]
    },
    "answers_when": "in_hours",
    "away_message": "away_message",
    "groups": true,
    "auto_release_after_h": 1,
    "instructions": "instructions",
    "reply_delay_s": 1,
    "split": true,
    "typing": true,
    "window_template": "window_template",
    "voice_replies": "never"
  },
  "created_at": "2024-01-15T09:30:00Z",
  "web": {
    "key": "key",
    "origins": [
      "origins"
    ],
    "appearance": {
      "accent": "accent",
      "accent_fg": "accent_fg",
      "font": "Inter",
      "radius": 1,
      "theme": "auto",
      "position": "right",
      "launcher_size": 1,
      "panel_width": 1,
      "panel_height": 1,
      "header": true,
      "css": "css"
    }
  }
}

A phone number’s SIP login at its provider: the agent calls out from it, the number as caller ID. The credentials go to the vault; they are never read back.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

channel_idstringRequired

Request

This endpoint expects an object.

usernamestringRequired1-120 characters

passwordstringRequired1-200 characters

hoststringOptionalformat: "^[A-Za-z0-9.-]{1,200}(:\d{1,5})?$"Defaults to sip.zadarma.com

Response

Successful Response

idstring

agent_idstring

kindenum

Allowed values:

providerstring

namestring

external_idstring

addressstring or null

outboundboolean

statusenum

Allowed values:

detailstring or null

settingsobject

created_atdatetime

webobject or nullOptional

A web channel as its panel shows it: the key the snippet carries, the sites, the look.

Errors

422

Channels Outbound Set Request Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors