Skip to main content
POST
/
v1
/
voice
/
tools
cURL
curl --request POST \
  --url https://api.comm.com/api/v1/voice/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tool_type": "webhook",
  "name": "<string>",
  "description": "<string>",
  "endpoint_url": "<string>",
  "source_addr": "<string>",
  "endpoint_method": "GET",
  "parameters": [
    {
      "name": "<string>",
      "type": "string",
      "description": "<string>",
      "example": "<string>"
    }
  ],
  "mark_as_qualified": false
}
'
{
  "data": {
    "id": "<string>",
    "team_id": "<string>",
    "meta": {
      "tool_type": "webhook",
      "name": "<string>",
      "description": "<string>",
      "endpoint_url": "<string>",
      "source_addr": "<string>",
      "endpoint_method": "GET",
      "parameters": [
        {
          "name": "<string>",
          "type": "string",
          "description": "<string>",
          "example": "<string>"
        }
      ],
      "mark_as_qualified": false
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

AgentToolMetaDataRequest

​
tool_type
enum<string>
required
Available options:
webhook,
hangup_call,
update_contact,
update_call,
unsubscribe,
send_sms
​
name
string
required
​
description
string
required
​
endpoint_url
string | null
​
source_addr
string | null
​
endpoint_method
enum<string> | null
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
​
parameters
object[] | null
​
mark_as_qualified
boolean
default:false

Response

AgentToolsResource

​
data
AgentToolsResource · object
required