Create a binding

​

Binds a point of ingress for intelligence. Supply a configuration_id to analyse every conversation arriving there automatically under that configuration — no per-conversation API call — or omit it to enable call tracking on the target only, so you can start sessions on demand. A supplied configuration must be one of your account's active configurations (422 otherwise), and the target must be one you can bind today — a voice trunk or number (422 for an unsupported target). A target can hold only one binding (409 otherwise); park or delete the existing one to rebind it.

Required scope: intelligence:write

Body·
required
application/json

Body for binding a point of ingress for intelligence.

  • target
    Type: object ·
    required

    The point of ingress this binding applies to.

  • configuration_id
    Type: string · Configuration Idnullable

    UUID of the configuration to apply automatically to every conversation at this ingress point — must be one of your account's active configurations. Omit it to enable call tracking on the target only: no session is created automatically, but you can start one on demand for any call there.

  • enabled
    Type: boolean · Enabled

    Whether the binding is in force. Set false to park it without deleting it.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/bindings
curl https://api.simwood.com/intelligence/v1/bindings \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "configuration_id": "",
  "target": {
    "medium": "voice",
    "type": "",
    "key": ""
  },
  "enabled": true
}'

{
  "uuid": "string",
  "configuration_id": "string",
  "target": {
    "medium": "voice",
    "type": "string",
    "key": "string"
  },
  "enabled": true,
  "target_status": "active",
  "sync_state": "live",
  "created_at": "string",
  "updated_at": "string"
}

Successful Response

Simwood API Documentation