English

Português

English

Português

Appearance

SIP Integration ​

SipPulse AI allows SIP integration through its Proxy sip:sip.sippulse.ai:5060

Section Content ​

Connecting to the SipPulse AI SIP Trunk
Configuring an inbound trunk
Configuring an outbound trunk

Connecting to the SipPulse AI SIP Trunk ​

This process is still manual and must be requested from support. The Support team will create a username and password for the integration. From there, the client can connect to the SIP trunk using the following data:

Destination URI: sip.sip.sippulse.ai
Port: 5060
Username: (Provided by support)
Password: (Provided by support)
Prefix: Authorized numeric prefix (Example: +5510222201) — only numbers within this range are authorized
Rate Limit: 1 request every 10 seconds by default; can be increased in specific cases

Configuring an Inbound Trunk ​

In the Voice Bot configuration, you will set up a telephone number and authorize an IP address.

1 - Authorize the IP sip.sippulse.ai, currently 94.72.162.182
2 - Add the telephone number within the authorized prefix range, e.g., +551022220101

SIP Inbound Trunk

Passing Parameters ​

To pass parameters to the agent, such as variables, you can use the header

X-Additional-Instructions

It receives the variables in JSON encoded in Base64.

Example:

{ "name": "John Doe", "installment": 5000 }

Value in Base64

ewogICAgIm5vbWVfZG9fY2xpZW50ZSI6ICJHdW1lcmNpbmRvIFNpbHZhIiwKICAgICJ2YWxvcl9kYV9wYXJjZWxhIjogNTAwMAp9

To send the data, use the SIP header

X-Additional-Instructions: ewogICAgIm5vbWVfZG9fY2xpZW50ZSI6ICJHdW1lcmNpbmRvIFNpbHZhIiwKICAgICJ2YWxvcl9kYV9wYXJjZWxhIjogNTAwMAp9

Configuring the Outbound Trunk ​

For the outbound trunk, you will need to create an extension on your telephone system and use these details to make calls through your SIP Trunk.

In the outbound trunk, you must specify the address of your SIP Trunk:

address: Your SIP Trunk address
number: The caller ID with which the call will be made
enable_authentication: Enable authentication
username: User's name
password: Password

SIP Outbound Trunk

Passing Parameters ​

The SIP outbound trunk is triggered by a RESTful API.

It uses the POST method with the endpoint:
https://api.sippulse.ai/bots/{id}/outbound-call

In the body, use:

{ "number": "string", "initial_text": "string", "additional_instructions": "string", "activation_threshold": 3.5 }

More details at: https://api.sippulse.ai/explorer/#/BotController/BotController.makeOutboundCall