Vocallabs API Docs

Create Authentication Token

POST

https://api.superflow.run/b2b/createAuthToken/

Headers

Key	Value
`Content-Type`	`application/json`

Request Body

json

{
	"clientId": "CLIENT_ID",
	"clientSecret": "CLIENT_SECRET"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/createAuthToken/' \
  -H 'Content-Type: application/json' \
  -d '{
	"clientId": "CLIENT_ID",
	"clientSecret": "CLIENT_SECRET"
}'

Get Wallet Balance

GET

https://api.superflow.run/b2b/getGreenBalance

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/getGreenBalance' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Transaction History

GET

https://api.superflow.run/b2b/whatsubTransactionHistory

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/whatsubTransactionHistory?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

SIP call API

POST

https://api.superflow.run/b2b/vocallabs/createSIPCall

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/11.0.2`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
  "phone_number": "NUMBER",
  "did": "DID",
  "websocket_url": "WEBSOCKET_URL",
  "webhook_url": "WEBHOOK_URL",
  "sample_rate": "SAMPLE_RATE"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createSIPCall' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/11.0.2' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
  "phone_number": "NUMBER",
  "did": "DID",
  "websocket_url": "WEBSOCKET_URL",
  "webhook_url": "WEBHOOK_URL",
  "sample_rate": "SAMPLE_RATE"
}
'

Initiate Call

POST

https://api.superflow.run/b2b/vocallabs/initiateVocallabsCall

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"agentId": "AGENT_ID",
	"prospect_id": "PROSPECT_ID"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/initiateVocallabsCall?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agentId": "AGENT_ID",
	"prospect_id": "PROSPECT_ID"
}'

Get Call Details

GET

https://api.superflow.run/b2b/vocallabs/getVocallabsCall

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`callId`	`CALL_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getVocallabsCall?callId=CALL_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Voices

GET

https://api.superflow.run/b2b/vocallabs/getVoices

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getVoices?0=' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call API Tokens

GET

https://api.superflow.run/b2b/vocallabs/getCallAPITokens

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallAPITokens?0=' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Call API

POST

https://api.superflow.run/b2b/vocallabs/initiateCallWebhook

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.0`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
  "from": "DID",
  "number": "NUMBER"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/initiateCallWebhook' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.0' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
  "from": "DID",
  "number": "NUMBER"
}
'

Get Call Timeline

GET

https://api.superflow.run/b2b/vocallabs/getCallTimeline

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`phone_to`	`PHONE_TO`
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallTimeline?phone_to=PHONE_TO&limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Daily Calls

GET

https://api.superflow.run/b2b/vocallabs/getDailyCalls

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`start_date`	`START_DATE`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getDailyCalls?start_date=START_DATE' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Websocket url

GET

https://api.superflow.run/b2b/vocallabs/getWebsocketUrl

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`
`prospect_id`	`PROSPECT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getWebsocketUrl?agent_id=AGENT_ID&prospect_id=PROSPECT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Audit one

GET

https://api.superflow.run/b2b/vocallabs/getOneAudit

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`call_id`	`CALL_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getOneAudit?call_id=CALL_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Audits

GET

https://api.superflow.run/b2b/vocallabs/getAllAudits

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAllAudits' \
  -H 'Authorization: Bearer AUTH_TOKEN'

upload audio Url

POST

https://api.superflow.run/b2b/vocallabs/uploadAudits

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.0`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"agent_id": "AGENT_ID",
	"recording_url": [
		"example1.wav",
		"example2.wav"
	]
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/uploadAudits' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.0' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agent_id": "AGENT_ID",
	"recording_url": [
		"example1.wav",
		"example2.wav"
	]
}

'

Create Direct Call

POST

https://api.superflow.run/b2b/vocallabs/createDirectCall

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"client_token_id": "CLIENT_TOKEN_ID",
	"number": "NUMBER"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createDirectCall?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"client_token_id": "CLIENT_TOKEN_ID",
	"number": "NUMBER"
}'

Hangup Call

POST

https://api.superflow.run/b2b/vocallabs/hangupCall

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"call_id": "3aa6340b-8b4b-4bc7-923f-614e1ee28318"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/hangupCall?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"call_id": "3aa6340b-8b4b-4bc7-923f-614e1ee28318"
}'

Get Agents

GET

https://api.superflow.run/b2b/vocallabs/getAIAgents

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAIAgents?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent By ID

GET

https://api.superflow.run/b2b/vocallabs/getAIAgentByID

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAIAgentByID?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create New Agent

POST

https://api.superflow.run/b2b/vocallabs/createAIAgent

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"name" : "AGENT_NAME"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createAIAgent?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name" : "AGENT_NAME"
}'

Update Agent by ID

POST

https://api.superflow.run/b2b/vocallabs/updateAIAgent

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`

Request Body

json

{
	"agent_id": 
"AGENT_ID",
"name": 
"AGENT_NAME",
"inputs_needed": 
{
"contact_id": 
"CONTACT_ID"
},
"welcome_message": 
"AGENT_WELCOME_MESSAGE",
"agent_prompt": 
"Hello , your ID is .",
"analytics_prompt": 
"AGENT_ANALYTICS_PROMPT",
"language": 
"AGENT_LANGUAGE",
"call_token_id": 
"CALL_TOKEN_ID",
"voice_id": 
"VOICE_ID"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateAIAgent?agent_id=AGENT_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agent_id": 
"AGENT_ID",
"name": 
"AGENT_NAME",
"inputs_needed": 
{
"contact_id": 
"CONTACT_ID"
},
"welcome_message": 
"AGENT_WELCOME_MESSAGE",
"agent_prompt": 
"Hello , your ID is .",
"analytics_prompt": 
"AGENT_ANALYTICS_PROMPT",
"language": 
"AGENT_LANGUAGE",
"call_token_id": 
"CALL_TOKEN_ID",
"voice_id": 
"VOICE_ID"
}'

Get Agent Templates

GET

https://api.superflow.run/b2b/vocallabs/getAgentTemplates

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentTemplates' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get voices by language

GET

https://api.superflow.run/b2b/vocallabs/getVoicesByLanguageComment

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`language`	`ENGLISH`
`1`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getVoicesByLanguageComment?1=&language=ENGLISH' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Toggle favorite

POST

https://api.superflow.run/b2b/vocallabs/toggleFavorite

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	
"agent_id": 
"AGENT_ID",
"favorite": 
true
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/toggleFavorite' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"agent_id": 
"AGENT_ID",
"favorite": 
true
}'

update visibility of agent

POST

https://api.superflow.run/b2b/vocallabs/updateAgentShared

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	
"agent_id": 
"AGENT_ID",
"isShared": 
true
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateAgentShared' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"agent_id": 
"AGENT_ID",
"isShared": 
true
}'

Agent prompt History

POST

https://api.superflow.run/b2b/vocallabs/agentPromptHistory

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	
"agent_id": "AGENT_ID"

}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/agentPromptHistory' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"agent_id": "AGENT_ID"

}'

Update success metric

POST

https://api.superflow.run/b2b/vocallabs/updateSuccessMetric

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	

"agent_id": 
"AGENT_ID",
"success_metric": 
{
"description": 
"<e.g. user is satisfied>",
	"another thing": "<desciption of another thing>"
}
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateSuccessMetric' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	

"agent_id": 
"AGENT_ID",
"success_metric": 
{
"description": 
"<e.g. user is satisfied>",
	"another thing": "<desciption of another thing>"
}
}'

Update whatsapp notification

POST

https://api.superflow.run/b2b/vocallabs/updateWhatsappNotification

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	

"agent_id": 
"AGENT_ID",
"value": 
true
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateWhatsappNotification' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	

"agent_id": 
"AGENT_ID",
"value": 
true
}'

Update mail notification

POST

https://api.superflow.run/b2b/vocallabs/updateMailNotification

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	

"agent_id": 
"AGENT_ID",
"value": 
true
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateMailNotification' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	

"agent_id": 
"AGENT_ID",
"value": 
true
}'

Get Agent Document

GET

https://api.superflow.run/b2b/vocallabs/getAgentDocuments

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentDocuments?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Insert Agent documents

POST

https://api.superflow.run/b2b/vocallabs/insertAgentDocx

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	

"file_name": 
"<your file name>",
"file_url": 
"https://chatgpt.com/c/683fe20c-a1c8-800b-bb69-238ced72f858",
"file_type": 
"<file type>",
"site_url": 
"https://chatgpt.com/c/683fe20c-a1c8-800b-bb69-238ced72f858",
"webcrawler_depth": 2,
"crawl_status": 
"<crawl status>"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/insertAgentDocx' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	

"file_name": 
"<your file name>",
"file_url": 
"https://chatgpt.com/c/683fe20c-a1c8-800b-bb69-238ced72f858",
"file_type": 
"<file type>",
"site_url": 
"https://chatgpt.com/c/683fe20c-a1c8-800b-bb69-238ced72f858",
"webcrawler_depth": 2,
"crawl_status": 
"<crawl status>"
}'

Get AI models

GET

https://api.superflow.run/b2b/vocallabs/getAIModels

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAIModels' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent reschedule

GET

https://api.superflow.run/b2b/vocallabs/getAgentActions

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentActions?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Agent reschedule

POST

https://api.superflow.run/b2b/vocallabs/updateAgentReschedule

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"agent_id": "AGENT_ID",
	"reschedule": true
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateAgentReschedule?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agent_id": "AGENT_ID",
	"reschedule": true
}'

Get agent keyword replacements

GET

https://api.superflow.run/b2b/vocallabs/getKeywordReplacements

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getKeywordReplacements?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get agent keywords

GET

https://api.superflow.run/b2b/vocallabs/getAgentKeywords

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentKeywords?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Add keywords replacements

POST

https://api.superflow.run/b2b/vocallabs/addKeyword

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
"objects": 
[
{
"agent_id": 
"AGENT_ID",
"keyword": 
"<keywords>",
"replacement": 
"<its replacement>"
}
]

}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/addKeyword' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
"objects": 
[
{
"agent_id": 
"AGENT_ID",
"keyword": 
"<keywords>",
"replacement": 
"<its replacement>"
}
]

}'

update keyword replacement

POST

https://api.superflow.run/b2b/vocallabs/updateKeyword

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
"keyword_id": 
"KEYWORD_ID",
"keyword": 
"<keyword>",
"replacement": 
"<its replacement>"

}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateKeyword' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
"keyword_id": 
"KEYWORD_ID",
"keyword": 
"<keyword>",
"replacement": 
"<its replacement>"

}'

delete keyword replacement

DELETE

https://api.superflow.run/b2b/vocallabs/deleteKeyword

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`keyword_id`	`KEYWORD_ID`

Code Examples

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteKeyword?keyword_id=KEYWORD_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent template

GET

https://api.superflow.run/b2b/vocallabs/getTemplate

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`template_agent_id`	`TEMPLATE_AGENT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getTemplate?template_agent_id=TEMPLATE_AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent samples

GET

https://api.superflow.run/b2b/vocallabs/getAgentSamples

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`template_agent_id`	`TEMPLATE_AGENT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentSamples?template_agent_id=TEMPLATE_AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Agent FAQs

GET

https://api.superflow.run/b2b/vocallabs/getAgentFaq

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getAgentFaq?agent_id=AGENT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Insert Agent FAQs

POST

https://api.superflow.run/b2b/vocallabs/agentFaq

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"agent_id": "AGENT_ID",
"ques_data": "<ques>",
"ans_data": "<ans>",
	"operation": "<delete|insert|update>",
"faq_id": "<faq-id> (not required in insert)"


}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/agentFaq?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"agent_id": "AGENT_ID",
"ques_data": "<ques>",
"ans_data": "<ans>",
	"operation": "<delete|insert|update>",
"faq_id": "<faq-id> (not required in insert)"


}'

Get Call statuses

GET

https://api.superflow.run/b2b/vocallabs/getCallStatuses

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallStatuses' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call Conversation

GET

https://api.superflow.run/b2b/vocallabs/getCallConversation

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`call_id`	`CALL_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallConversation?call_id=CALL_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call Data

GET

https://api.superflow.run/b2b/vocallabs/getCallData

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`call_id`	`CALL_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallData?call_id=CALL_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call Status

GET

https://api.superflow.run/b2b/vocallabs/getCallStatus

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`call_id`	`CALL_ID`

Request Body

json

{}

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallStatus?call_id=CALL_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Call Summary

GET

https://api.superflow.run/b2b/vocallabs/getCallSummary

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`call_id`	`CALL_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCallSummary?call_id=CALL_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

get post call data

GET

https://api.superflow.run/b2b/vocallabs/getPostCallData

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`agent_id`	`AGENT_ID`
`1`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getPostCallData?1=&agent_id=AGENT_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Post Call Data

POST

https://api.superflow.run/b2b/vocallabs/updatePostCallData

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	
"call_id": "CALL_ID",
"key": "<key>",
"prompt": "<prompt for getting the key>"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updatePostCallData?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"call_id": "CALL_ID",
"key": "<key>",
"prompt": "<prompt for getting the key>"
}'

Delete Post Call Data

POST

https://api.superflow.run/b2b/vocallabs/deletePostCallData

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	
"call_id": 
"CALL_ID"

}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/deletePostCallData?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"call_id": 
"CALL_ID"

}'

Get vocallabs Call Data

GET

https://api.superflow.run/b2b/vocallabs/getVocallabsCall

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`callId`	`CALL_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getVocallabsCall?callId=CALL_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create Contact Group

POST

https://api.superflow.run/b2b/vocallabs/createContactGroup

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"name": "CONTACT_GROUP_NAME"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createContactGroup?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name": "CONTACT_GROUP_NAME"
}'

Create Contact in Group

POST

https://api.superflow.run/b2b/vocallabs/createContactInGroup

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"name": "CONTACT_NAME",
	"phone":"NUMBER",
	"prospect_group_id":"PROSPECT_GROUP_ID"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createContactInGroup?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name": "CONTACT_NAME",
	"phone":"NUMBER",
	"prospect_group_id":"PROSPECT_GROUP_ID"
}'

Update Contact Metadata in Group

POST

https://api.superflow.run/b2b/vocallabs/updateContactMetadata

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`prospect_id`	`PROSPECT_ID`

Request Body

json

{
	"metadata": {
		"key": "value"
	}
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateContactMetadata?prospect_id=PROSPECT_ID' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"metadata": {
		"key": "value"
	}
}'

Get Contact Group

GET

https://api.superflow.run/b2b/vocallabs/getContactGroups

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getContactGroups?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Contact Group

POST

https://api.superflow.run/b2b/vocallabs/updateContactGroup

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"client_id": 
"USERID",
"id": 
"PROSPECT_GROUP_ID",
"name": 
"CONTACT_GROUP_NAME"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateContactGroup?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"client_id": 
"USERID",
"id": 
"PROSPECT_GROUP_ID",
"name": 
"CONTACT_GROUP_NAME"
}'

Delete Contact Group

DELETE

https://api.superflow.run/b2b/vocallabs/deleteContactGroup

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
"id": 
"{{ _.prospect_groups_id }}"
}

Code Examples

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteContactGroup?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
"id": 
"{{ _.prospect_groups_id }}"
}'

Delete Contact

DELETE

https://api.superflow.run/b2b/vocallabs/deleteContact

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
"contact_id": 
"CONTACT_ID"
}

Code Examples

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteContact?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
"contact_id": 
"CONTACT_ID"
}'

Get Contacts

GET

https://api.superflow.run/b2b/vocallabs/getContacts

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getContacts?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Add multiple contacts to group

POST

https://api.superflow.run/b2b/vocallabs/addMultipleContactsToGroup

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
  "prospects": [
    {
      "name": "John Doe",
      "phone": "+911204567690",
      "data": {
        "test": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    },
    {
      "name": "Jane Smith",
      "phone": "+914877543610",
      "data": {
        "key": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    }
  ]
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/addMultipleContactsToGroup' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
  "prospects": [
    {
      "name": "John Doe",
      "phone": "+911204567690",
      "data": {
        "test": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    },
    {
      "name": "Jane Smith",
      "phone": "+914877543610",
      "data": {
        "key": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    }
  ]
}
'

Get Contact Data

GET

https://api.superflow.run/b2b/vocallabs/getContactData

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`
`prospect_id`	`PROSPECT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getContactData?limit=LIMIT&offset=OFFSET&prospect_id=PROSPECT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Contact Data

POST

https://api.superflow.run/b2b/vocallabs/updateContactData

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"prospect_id": 
"PROSPECT_ID",
"data": 
{
"<key>": 
"<value>",
"<key2>": 
"<value2>"
}
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateContactData?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"prospect_id": 
"PROSPECT_ID",
"data": 
{
"<key>": 
"<value>",
"<key2>": 
"<value2>"
}
}'

Get Contact

GET

https://api.superflow.run/b2b/vocallabs/getContact

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`prospect_id`	`PROSPECT_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getContact?prospect_id=PROSPECT_ID' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create Contact Group V2

POST

https://api.superflow.run/b2b/vocallabs/createContactGroupV2

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{
	"name": "CONTACT_GROUP_NAME"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createContactGroupV2?0=' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name": "CONTACT_GROUP_NAME"
}'

Add multiple contacts to group V2

POST

https://api.superflow.run/b2b/vocallabs/addMultipleContactsToGroupV2

Headers

Key	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
  "prospects": [
    {
      "name": "John Doe",
      "phone": "+911204567690",
      "data": {
        "test": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    },
    {
      "name": "Jane Smith",
      "phone": "+914877543610",
      "data": {
        "key": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    }
  ]
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/addMultipleContactsToGroupV2' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
  "prospects": [
    {
      "name": "John Doe",
      "phone": "+911204567690",
      "data": {
        "test": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    },
    {
      "name": "Jane Smith",
      "phone": "+914877543610",
      "data": {
        "key": "test"
      },
      "prospect_group_id": "PROSPECT_GROUP_ID",
      "client_id": "USERID"
    }
  ]
}
'

Get Actions

GET

https://api.superflow.run/b2b/vocallabs/getActions

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActions' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create Action

POST

https://api.superflow.run/b2b/vocallabs/createAction

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`0`

Request Body

json

{	
	"action_name": 
"ACTION_NAME",
"description": 
"DESCRIPTION",
"external_curl": 
"EXTERNAL_CURL",
"success_response": 
"SUCCESS_RESPONSE",
"failure_response": 
"FAILURE_RESPONSE",
"interruption_response": 
"INTERRUPTION_RESPONSE",
"ref_code": 
"REF_CODE"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createAction?0=' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{	
	"action_name": 
"ACTION_NAME",
"description": 
"DESCRIPTION",
"external_curl": 
"EXTERNAL_CURL",
"success_response": 
"SUCCESS_RESPONSE",
"failure_response": 
"FAILURE_RESPONSE",
"interruption_response": 
"INTERRUPTION_RESPONSE",
"ref_code": 
"REF_CODE"
}'

Update Action

POST

https://api.superflow.run/b2b/vocallabs/updateAction

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"id" : "ACTION_ID",
	"action_name": 
"ACTION_NAME",
"description": 
"DESCRIPTION",
"external_curl": 
"EXTERNAL_CURL",
"success_response": 
"SUCCESS_RESPONSE",
"failure_response": 
"FAILURE_RESPONSE",
"interruption_response": 
"INTERRUPTION_RESPONSE",
"ref_code": 
"REF_CODE"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateAction' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"id" : "ACTION_ID",
	"action_name": 
"ACTION_NAME",
"description": 
"DESCRIPTION",
"external_curl": 
"EXTERNAL_CURL",
"success_response": 
"SUCCESS_RESPONSE",
"failure_response": 
"FAILURE_RESPONSE",
"interruption_response": 
"INTERRUPTION_RESPONSE",
"ref_code": 
"REF_CODE"
}'

Delete Action

DELETE

https://api.superflow.run/b2b/vocallabs/deleteAction

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"id" : "ACTION_ID"
}

Code Examples

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteAction' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"id" : "ACTION_ID"
}'

Get Documents

GET

https://api.superflow.run/b2b/vocallabs/getDocuments

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getDocuments' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Delete Document

DELETE

https://api.superflow.run/b2b/vocallabs/deleteDocument

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"id" : "DOCUMENT_ID"
}

Code Examples

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteDocument' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"id" : "DOCUMENT_ID"
}'

Get Action templates

GET

https://api.superflow.run/b2b/vocallabs/getActionTemplates

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionTemplates' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Action template details

GET

https://api.superflow.run/b2b/vocallabs/getActionTemplateDetails

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`template_action_id`	`TEMPLATE_ACTION_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionTemplateDetails?template_action_id=TEMPLATE_ACTION_ID' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Action Parameter

GET

https://api.superflow.run/b2b/vocallabs/getActionParameters

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`action_id`	`ACTION_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionParameters?action_id=ACTION_ID' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Action fields

GET

https://api.superflow.run/b2b/vocallabs/getActionFields

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`action_id`	`ACTION_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionFields?action_id=ACTION_ID' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Action Configuration

GET

https://api.superflow.run/b2b/vocallabs/getActionConfiguration

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`action_id`	`ACTION_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getActionConfiguration?action_id=ACTION_ID' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Flows

GET

https://api.superflow.run/b2b/vocallabs/getFlows

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getFlows' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Identity Url

POST

https://api.superflow.run/b2b/vocallabs/getIdentityUrl

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"flow_id": "FLOW_ID",
"prospect_id": "PROSPECT_ID",

"verification_type": "aadhaar or pan",
"created_at": "2025-10-09T12:05:17.875Z" 

}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/getIdentityUrl' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"flow_id": "FLOW_ID",
"prospect_id": "PROSPECT_ID",

"verification_type": "aadhaar or pan",
"created_at": "2025-10-09T12:05:17.875Z" 

}'

Get Dashboard stats

GET

https://api.superflow.run/b2b/vocallabs/getDashboardStats

Headers

Key	Value
`User-Agent`	`insomnia/11.1.0`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getDashboardStats' \
  -H 'User-Agent: insomnia/11.1.0' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Tokens

GET

https://api.superflow.run/b2b/vocallabs/getTokens

Headers

Key	Value
`User-Agent`	`insomnia/11.1.0`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getTokens' \
  -H 'User-Agent: insomnia/11.1.0' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Campaigns

GET

https://api.superflow.run/b2b/vocallabs/getCampaigns

Headers

Key	Value
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCampaigns' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Create Campaign

POST

https://api.superflow.run/b2b/vocallabs/createCampaign

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"name": "CAMPAIGN_NAME",
	"agent_id": "AGENT_ID"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/createCampaign' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"name": "CAMPAIGN_NAME",
	"agent_id": "AGENT_ID"
}'

Update Campaign

POST

https://api.superflow.run/b2b/vocallabs/updateCampaign

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"campaign_id": "CAMPAIGN_ID",
	"campaign_name": "CAMPAIGN_NAME"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateCampaign' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"campaign_id": "CAMPAIGN_ID",
	"campaign_name": "CAMPAIGN_NAME"
}'

Delete Campaign

DELETE

https://api.superflow.run/b2b/vocallabs/deleteCampaign

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"id" : "CAMPAIGN_ID"
}

Code Examples

bash

curl -X DELETE 'https://api.superflow.run/b2b/vocallabs/deleteCampaign' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"id" : "CAMPAIGN_ID"
}'

Get Queueing Details

GET

https://api.superflow.run/b2b/vocallabs/getQueueingDetails

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`
`campaign_id`	`CAMPAIGN_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getQueueingDetails?limit=LIMIT&offset=OFFSET&campaign_id=CAMPAIGN_ID' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Campaign Status

GET

https://api.superflow.run/b2b/vocallabs/getCampaignStatus

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`campaign_id`	`CAMPAIGN_ID`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getCampaignStatus?campaign_id=CAMPAIGN_ID' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Update Campaign Status

POST

https://api.superflow.run/b2b/vocallabs/updateCampaignStatus

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/10.3.1`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	
"campaign_id": 
"CAMPAIGN_ID",
	"active": false

}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/updateCampaignStatus' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/10.3.1' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	
"campaign_id": 
"CAMPAIGN_ID",
	"active": false

}'

Add Contacts to Campaign

POST

https://api.superflow.run/b2b/vocallabs/addContactsToCampaign

Headers

Key	Value
`Content-Type`	`application/json`
`User-Agent`	`insomnia/11.1.0`
`Authorization`	`Bearer AUTH_TOKEN`

Request Body

json

{
	"user_id": "CLIENT_ID",
	"campaign_id": "CAMPAIGN_ID",
	"prospect_group_id":"PROSPECT_GROUP_ID"
}

Code Examples

bash

curl -X POST 'https://api.superflow.run/b2b/vocallabs/addContactsToCampaign' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: insomnia/11.1.0' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -d '{
	"user_id": "CLIENT_ID",
	"campaign_id": "CAMPAIGN_ID",
	"prospect_group_id":"PROSPECT_GROUP_ID"
}'

Fetch Available Numbers

GET

https://api.superflow.run/b2b/vocallabs/fetchAvailableNumbers

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/fetchAvailableNumbers?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Get Your Numbers

GET

https://api.superflow.run/b2b/vocallabs/getNumbers

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/getNumbers?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'

Fetch Countries

GET

https://api.superflow.run/b2b/vocallabs/fetchCountries

Headers

Key	Value
`Authorization`	`Bearer AUTH_TOKEN`

Query Parameters

Key	Value
`limit`	`LIMIT`
`offset`	`OFFSET`

Code Examples

bash

curl -X GET 'https://api.superflow.run/b2b/vocallabs/fetchCountries?limit=LIMIT&offset=OFFSET' \
  -H 'Authorization: Bearer AUTH_TOKEN'