Announcing the New REST API Feature in SIP Caller
We are excited to announce a powerful new feature for SIP Caller that will streamline your campaign management and enhance your calling efficiency. With the latest update, you can now add numbers to an existing campaign using our newly introduced REST API. This feature is designed to offer you more flexibility and control over your campaigns, allowing for dynamic updates without the need for manual intervention. |
Why This Feature Matters
Previously, adding numbers to a campaign required manual input through the SIP Caller interface. By introducing the REST API, we’re enabling you to automate this process, making it faster and more scalable. Whether you’re integrating SIP Caller with your CRM, a custom database, or any other system, this API will allow you to seamlessly add numbers to your campaigns in real-time.
How It Works
Using the REST API is straightforward. Below is an example of how to invoke the API to add a number to an existing campaign:
curl --include \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_KEY_TOKEN' \
--request POST \
--data-raw '{"number": "+18005552222"}' \
'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers'
If the campaign requires values for variables associated with each number, you can invoke the request as follows:
curl --include \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_KEY_TOKEN' \
--request POST \
--data-raw '{"number": "+18005552223", "varValues": ["John", "250"]}' \
'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers'
In this example:
- Replace ACCOUNT_ID with the ID of your account.
- Replace CAMPAIGN_ID with the ID of your campaign.
- Replace API_KEY_TOKEN with the API key you generate (we’ll cover how to create this key below).
- The payload (--data-raw) contains the phone number you wish to add and any custom fields you want to associate with this entry.
Creating an API Key
To use the REST API, you’ll need to create an API key. Here’s how to do it:
- Log in to SIP Caller: Start by logging into your SIP Caller dashboard.
- Navigate to API Settings: Go to 'Settings' > ‘API Keys’.
- Create a New API Key: Click on 'Create' and you’ll be prompted to name your key, establish an expiration, and set its permissions.
- Copy the API Key Token: Once created, copy the API key token that will be shown. Please note that this token is only shown once, if you lose it you will need to create another API Key. You’ll need this key for authenticating your API requests.
Use Cases and Benefits
The REST API opens up many possibilities, including:
- Automated Campaign Management: Integrate with your CRM to automatically add leads to campaigns based on specific triggers.
- Real-Time Updates: Quickly respond to changes in your calling lists, ensuring your campaigns are always up-to-date.
- Enhanced Data Control: Pass custom data fields with each number, giving you more control over your campaign behavior.
Get Started Today
We believe this new feature will greatly enhance your experience with SIP Caller. As always, we’re here to help. If you have any questions or need support, don’t hesitate to contact us.
