Skip to main content
POST
/
v2
/
add
/
contact
Custom Add Contact
curl --request POST \
  --url https://app.closerx.ai/api/v2/add/contact/ \
  --header 'Company-Name: <company-name>' \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "phone_number": "string",
  "termination_uri": "string",
  "sip_trunk_auth_username": "string",
  "sip_trunk_auth_password": "string",
  "nickname": "string",
  "source_of_origin": "string"
}
'
{
  "success": true,
  "message": "contact created",
  "data": {
    "pk": "integer",
    "phone_number": "string",
    "termination_uri": "string",
    "sip_trunk_auth_username": "string",
    "sip_trunk_auth_password": "string",
    "nickname": "string",
    "source_of_origin": "string",
    "phone_number_sid": "string | null",
    "verification_status": "string | null",
    "in_used_by_agent": "string",
    "is_auto_buyed": "boolean"
  }
}

Authorizations

api_key
string
header
required

Headers

Company-Name
string
required

Schema name for multi-tenancy

Body

application/json
phone_number
string
required

The phone number to register

Example:

"+917418520030"

termination_uri
string
required

The SIP termination URI (used for routing)

Example:

"popuptesting"

sip_trunk_auth_username
string
required

SIP trunk authentication username

sip_trunk_auth_password
string
required

SIP trunk authentication password

Example:

"2345$"

nickname
string
required

A friendly name or nickname for the number

Example:

"testingg"

source_of_origin
string
required

The source from which the contact originates

Example:

"custom"

Response

Contact created successfully

success
boolean
Example:

true

message
string
Example:

"contact created"

data
object