Campaign Contacts

This guide describes the APIs available to automatically manage Engage campaign contacts. Using these APIs you can:

 

Overview

Campaign contacts are the recipients of your communication. Engage campaign contacts can be manually managed through the Engage menu option at the top of the CPaaS Portal or the Engage application within the Customer Portal, but you can also automate campaign lists through our APIs.

 

Getting Started

Before you begin using these APIs make sure you've obtained an authentication token, and check out the API Basics page to learn more about basic requirements for using the APIs.

Note: For all requests, Content-Type and Accept headers must be in JSON format.

 

Base URL

All of the following endpoints share the same base URL:

https://engage.intelepeer.com

(e.g., GET/https://engage.intelepeer.com/_rest/v2/contacts).

 

Campaign Contacts APIs

Click on the APIs below to view the parameters and code samples associated with each endpoint.

 

Use this endpoint to get details on a particular contact in Engage.

Endpoint

GET /_rest/v2/contacts

 

Sample Request

Note: Use the Retrieve List Details endpoint with the ID parameter to get the Contact ID.

GET /_rest/v2/contacts?id=6214f5d34b99a300098407ea

 

Sample Responses

Code 200 Response

Response code 200 returns details on a particular contact.

{
    "listId": "6214f5d34b99a300098407ea",
    "deleteFlag": false,
    "modifiedBy": "*",
    "createdBy": "*",
    "modifiedDate": "2022-02-22T15:20:05.000Z",
    "createdDate": "2022-02-22T15:20:05.000Z",
    "metadata": {
        "firstname": "Lucia",
        "lastname": "Perera"
    },
    "_id": "62151592c35e1400093c7e1f",
    "customerId": "1028811",
    "location": "US",
    "timezone": null
}

 

Code 401 Response

Response code 401 returns an error that the authorization token is invalid.

 

Code 404 Response

Response code 404 returns a message that the contact Id is incorrect and the contact is not found.

 

Code 500 Response

Response code 500 returns an error when trying to retrieve contact details.

 

 

Use this endpoint to add one or more contacts to an existing list in Engage.

Endpoint

PUT /_rest/v2/lists/:id/uploadcontacts

Note: You must send your request in JSON format.

Parameters

  • List Id

Body

Required fields:

  • contactInfo

  • phone

Optional fields:

  • Other contact fields can also be added under "metadata" (e.g., firstname, email)

 

Sample Request
{
	"contactInfo":[
	{
		"phone": "1231231234",
		"metadata": {
			"Firstname": "Abby",
			"Lastname": "Smith",
			"email": "EmailAddress746@mail.com"
		}
	},
	{	
		"phone": "2342342345",
		"metadata": {
			"Firstname": "Lucia",
			"Lastname": "Perera",
			"email": "EmailAddress44@mail.com"
		}
	}
	]
}

 

Sample Responses

Code 201 Response

Response code 201 returns a list with newly created contactIds under “contactRel”.

{
    "listName": "Engage List",
    "description": "This is a list description. EX:Customer Conacts, Product Info, General Notes ",
    "modifiedDate": "2022-02-22T16:42:39.260Z",
    "modifiedBy": "*",
    "createdDate": "2022-02-22T14:40:19.813Z",
    "createdBy": "*",
    "deleteFlag": false,
    "customerId": "1028811",
    "campaignRel": [],
    "contactRel": [
        "621511343481510009d9efbc",
        "621511343481510009d9efbd",
        "6215127f95ecce0009982f20",
        "6215127f95ecce0009982f21"
    ],
    "_id": "6214f5d34b99a300098407ea",
    "state": 0,
    "autoDetectTZ": null,
    "location": "US",
    "headerInfo": {
        "headers": [
            "firstname",
            "lastname"
        ]
    }
}

 

Code 401 Response

Response code 401 returns an error that the authorization token is invalid.

 

Code 422 Response

Response code 422 returns a message that the listId is invalid or does not exist.

 

Code 500 Response

Response code 500 returns an error when an unknown internal error occurs.

 

 

Use this endpoint to remove a contact from Engage.

Note: The deleted contact is removed from all lists it was associated with.

Endpoint

DELETE /_rest/v2/contacts/:id

 

Sample Request

DELETE /_rest/v2/contacts/5f7f2567360f8829c8b1cd40

 

Sample Responses

Code 202 Response

Response code 202 returns a boolean value of true indicating that the contact is in the process of deleting or has been deleted.

true

 

Code 401 Response

Response code 401 returns an error that the authorization token is invalid.

 

Code 404 Response

Response code 404 returns a message that the contact Id was incorrect.

 

Code 500 Response

Response code 500 returns an error when trying to delete the contact.

 

 

{
	"streaming_voice": "azure,en-US-AvaNeural",
	"barge": true,
	"audios": [
		{
			"type": "tts-adaptive",
			"text": "$ai_response",
			"stream_at":20
		}
	],
	"timeoutseconds": 15,
	"asrsettings": {
	"model": "dgv1_default",
	"dtmf": {
		"mode": "override-asr",
		"term": "#",
		"max": 10,
		"min": 6
	},
	"kwargs": {
		:{"endpointing": 400, 
		"utterance_end_ms":1300, 
		"model": "nova-2-phonecall""
	},
	"export_transformations": "numerize|collapsenumbers|cleansenumbers"
	}
}