+91 7097 17 17 17

DEVELOPER

API For Developing

API Work Flow

Our application is a user friendly application that invisibly makes a communication to happen between programs and software applications. Office24by7 offers Secured and Powerful API suites for easy integration of multichannel platforms of businesses with all necessary provisions.

Our API’s functions as gateways exposing our application functionalities to all external applications safely and securely and is well versed in limiting and managing the acts of external application analytically.

getProductCompanies

https://voiceapi.office24by7.com/getProductCompanies?apiKey=[xxxxx]&productName=[xxxxx]&toDate=[xxxxx]&format =[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
productName Product Name Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Branches Info API

https://voiceapi.office24by7.com/getBranches?apiKey=[xxxxx]&format=[xxxxx]&limit=[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Divisions Info API

https://voiceapi.office24by7.com/getDivisions?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset =[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
CompanyName company's registered name No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Users Info API

https://voiceapi.office24by7.com/getUsers?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset =[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

User Privileges Info API

https://voiceapi.office24by7.com/getUserPrivileges?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Skills Info API

https://voiceapi.office24by7.com/getSkills?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Languages Info API

https://voiceapi.office24by7.com/getLanguages?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Companies Info API

https://voiceapi.office24by7.com/getCompanies?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset =[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Sender Names Info API

https://voiceapi.office24by7.com/getSenderNames?apiKey=[xxxxx]&format=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes

Sample Code

Working with the Technology

Response

Audios Info API

https://voiceapi.office24by7.com/getAudios?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Email Settings Info API

https://voiceapi.office24by7.com/getEmailSettings?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Short URLs Info API

https://voiceapi.office24by7.com/getShortURLs?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Holidays Info API

https://voiceapi.office24by7.com/getHolidays?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Call Status Info API

https://voiceapi.office24by7.com/getCallStats?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Notifications Info API

https://voiceapi.office24by7.com/getNotifications?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Scripts Info API

https://voiceapi.office24by7.com/getScripts?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Breaks Timings Info API

https://voiceapi.office24by7.com/getBreaksTimings?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

User RecentActivities Info API

https://voiceapi.office24by7.com/apis/getUserRecentActivities?apiKey=[xxxxx]&userLoginID=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format =[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
UserLoginID registered User LoginID No
FromDate Specified search start date No
ToDate Specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Operator Performance Info API

https://voiceapi.office24by7.com/getAgentPerformance?apiKey=[xxxxx]&agentLoginID=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format =[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
OperatorLoginID registered Operator LoginID No
FromDate Specified search start date No
ToDate Specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

UsersLogin Report Info API

https://voiceapi.office24by7.com/getUsersLoginReport?apiKey=[xxxxx]&userLoginID=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
CompanyName company’s registered name No
UserLoginID registered User LoginID No
FromDate Specified search start date No
ToDate Specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Recent Activities Info API

https://voiceapi.office24by7.com/getRecentActivities?apiKey=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset =[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
CompanyName company’s registered name No
FromDate Specified search start date No
ToDate Specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Login Report Info API

https://voiceapi.office24by7.com/getLoginReport?apiKey=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset =[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
CompanyName company’s registered name No
FromDate Specified search start date No
ToDate Specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

EmailReport Info API

https://voiceapi.office24by7.com/getEmailReport?apiKey=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format =[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
FromDate Specified search start date No
ToDate Specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

SMSReport Info API

https://voiceapi.office24by7.com/getSMSReport?apiKey=[xxxxx]&format =[xxxxx]&limit =[xxxxx]&offset =[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Detailed CallReport API

https://voiceapi.office24by7.com/getDetailedCallReport?apiKey=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&listName=[xxxxx]&campaignName=[xxxxx]&groupName=[xxxxx]&userPhoneNumber=[xxxxx]&callType=[xxxxx]&userType=[xxxxx]&loginType=[xxxxx]&branchName=[xxxxx]&agentLoginID=[xxxxx]&userName=[xxxxx]&format=[xxxxx]&limit=[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
ListName & CampaignName campaign listname and campaignname Yes
DivisionName company's divisionname in campaign Yes
UserPhoneNumber customer mobilenumber Yes
CallType inbound & outbound Yes
UserType type to which the user belongs Yes
loginType type to login i.e organization or user Yes
branchName branch name of the specified registered company Yes
OperatorLoginID registered operator loginid Yes
userName type to which the user belongs Yes
FromDate specified search start date No
ToDate specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Calls Count Info API

https://voiceapi.office24by7.com/getCallsCount?apiKey=[xxxxx]& (listName & campaignName)/(userName&groupName)/locationName=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
ListName & CampaignName company’s listname and campaignname No
UserName & DivisionName registered username and divisionname No
LocationName Specified search location name No
FromDate Specified search start date No
ToDate Specified search end date No

Sample Code

Working with the Technology

Response

Operator CallReport Info API

https://voiceapi.office24by7.com/getAgentCallReport?apiKey=[xxxxx]&agentLoginID=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset =[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
OperatorLoginID registered Operator LoginID No
FromDate Specified search start date No
ToDate Specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Campaigns Info API

https://voiceapi.office24by7.com/getCampaigns?apiKey=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Campaign Report Info API

https://voiceapi.office24by7.com/getCampaignReport?apiKey=[xxxxx]&CampaignName=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
CampaignName name of the campaign Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Active Numbers Info API

https://voiceapi.office24by7.com/getActiveNumbers?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Active Plan Info API

https://voiceapi.office24by7.com/getActivePlanInfo?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Account Price Info API

https://voiceapi.office24by7.com/getAccountPriceInfo?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Account Info API

https://voiceapi.office24by7.com/getAccountInfo?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Order History Info API

https://voiceapi.office24by7.com/getOrderHistory?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Invoice Info API

https://voiceapi.office24by7.com/getInvoice?apiKey=[xxxxx]&format=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes

Sample Code

Working with the Technology

Response

Balance History Info API

https://voiceapi.office24by7.com/getBalanceHistory?apiKey=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
FromDate Specified search start date No
ToDate Specified search end date No
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Generate Lead Info API

https://voiceapi.office24by7.com/clickToConnect?apiKey=[xxxxx]&cust_number=[xxxxx]&listname=[xxxxx]&source_type=[xxxxx]&format=[xxxx]

Input Parameters Description

Parameter Description Required
apiKey Registered company API key Yes
cust_number Customer number Yes
listname Data List Name Yes
source_type Data Source Name Yes
format Response in xml/html/json/php Format Yes

Sample Code

Working with the Technology

Response

WhiteList Contacts Info API

https://voiceapi.office24by7.com/getWhiteListContacts?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

BlockList Contacts Info API

https://voiceapi.office24by7.com/getBlockListContacts?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Clients Info API

https://voiceapi.office24by7.com/getClients?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Contacts Info API

https://voiceapi.office24by7.com/getContacts?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

DataList Info API

https://voiceapi.office24by7.com/getDataList?apiKey=[xxxxx]&format=[xxxxx]&limit =[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

RemoteIPs Info API

https://voiceapi.office24by7.com/getRemoteIPs?apiKey=[xxxxx]&format=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes

Sample Code

Working with the Technology

Response

RealTime Operators Info API

https://voiceapi.office24by7.com/getRealTimeAgents?apiKey=[xxxxx]&format=[xxxxx]&limit=[xxxxx]&offset=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
Offset The specified start and end of the limit clause records No
Limit the limit clause to specify the exact number of records No

Sample Code

Working with the Technology

Response

Click To Call API

https://voiceapi.office24by7.com/clickToCall?apiKey=[xxxxx]&servienumber=[xxxxx]&agentloginid=[xxxxx]&customernumber=[xxxxx]&isRecordCall=[xxxxx]&format=[xxxx]

Input Parameters Description

Parameter Description Required
API Key registered company API key Yes
Format response in xml/html/json/php Yes
serviceNum company’s service number Yes
OperatorLoginID registered operator loginid Yes
Customer MobileNumber customer mobilenumber Yes
IsRecordCall recoding call while talking with customer Yes

Sample Code

Working with the Technology

Response

Custom API

×

E
n
q
u
i
r
y