CallFire has a new API!
We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
Return campaign registration link that agents can use to register for a campaign.
(ex: https://www.callfire.com/ui/register/agent/c1ca1280-64c8-11e4-8fe5-00136e4efdeb)
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| GetAgentInviteUriRequest | Get agent invite registration uri | object | |
| CampaignId | CCC Campaign to invite agents to | long | |
| AgentEmail | Agent email to send invite to | EmailAddress |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| GetAgentInviteUriResponse | Agent invite registration uri | |
| AgentInviteUri | Agent invite registration uri | anyURI |
| CampaignId | CCC campaign id agent registration uri belongs to | long |