+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.

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]&companyName=[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 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]&companyName=[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 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

UserPrivileges Info API

https://voiceapi.office24by7.com/getUserPrivileges?apiKey=[xxxxx]&companyName=[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 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

Skills Info API

https://voiceapi.office24by7.com/getSkills?apiKey=[xxxxx]&companyName=[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 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

Languages Info API

https://voiceapi.office24by7.com/getLanguages?apiKey=[xxxxx]&companyName=[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 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

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
CompanyName company 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

SenderNames 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]&companyName=[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 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

EmailSettings Info API

https://voiceapi.office24by7.com/getEmailSettings?apiKey=[xxxxx]&companyName=[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 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

ShortURLs Info API

https://voiceapi.office24by7.com/getShortURLs?apiKey=[xxxxx]&companyName=[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 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

Holidays Info API

https://voiceapi.office24by7.com/getHolidays?apiKey=[xxxxx]&companyName=[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 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

CallStatus Info API

https://voiceapi.office24by7.com/getCallStats?apiKey=[xxxxx]&companyName=[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 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

Notifications Info API

https://voiceapi.office24by7.com/getNotifications?apiKey=[xxxxx]&companyName=[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 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

Scripts Info API

https://voiceapi.office24by7.com/getScripts?apiKey=[xxxxx]&companyName=[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 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

BreaksTimings Info API

https://voiceapi.office24by7.com/getBreaksTimings?apiKey=[xxxxx]&companyName=[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 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

UserRecentActivities Info API

https://voiceapi.office24by7.com/apis/getUserRecentActivities?apiKey=[xxxxx]&userLoginID=[xxxxx]&companyName=[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 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

OperatorPerformance Info API

https://voiceapi.office24by7.com/getAgentPerformance?apiKey=[xxxxx]&agentLoginID=[xxxxx]&companyName=[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 registered name No
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

UsersLoginReport Info API

https://voiceapi.office24by7.com/getUsersLoginReport?apiKey=[xxxxx]&userLoginID=[xxxxx]&companyName=[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 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

RecentActivities Info API

https://voiceapi.office24by7.com/getRecentActivities?apiKey=[xxxxx]&companyName=[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 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

LoginReport Info API

https://voiceapi.office24by7.com/getLoginReport?apiKey=[xxxxx]&companyName=[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 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]&companyName=[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 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

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

DetailedCallReport API

https://voiceapi.office24by7.com/getDetailedCallReport?apiKey=[xxxxx]&fromDate=[xxxxx]&toDate=[xxxxx]&listName=[xxxxx]&campaignName=[xxxxx]&groupName=[xxxxx]&companyName=[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 divisionname in campaign Yes
CompanyName company registered name 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

CallsCount Info API

https://voiceapi.office24by7.com/getCallsCount?apiKey=[xxxxx]& (listName & campaignName)/(userName&groupName)/locationName=[xxxxx]&companyName=[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 listname and campaignname No
UserName & DivisionName registered username and divisionname No
LocationName Specified search location name No
CompanyName company registered name No
FromDate Specified search start date No
ToDate Specified search end date No

Sample Code

Working with the Technology

Response

OperatorCallReport Info API

https://voiceapi.office24by7.com/getAgentCallReport?apiKey=[xxxxx]&agentLoginID=[xxxxx]&companyName=[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 registered name No
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]&companyName=[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 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

CampaignReport 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

ActiveNumbers Info API

https://voiceapi.office24by7.com/getActiveNumbers?apiKey=[xxxxx]&companyName=[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 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

ActivePlanInfo API

https://voiceapi.office24by7.com/getActivePlanInfo?apiKey=[xxxxx]&companyName=[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 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

AccountPrice Info API

https://voiceapi.office24by7.com/getAccountPriceInfo?apiKey=[xxxxx]&companyName=[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 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

Account Info API

https://voiceapi.office24by7.com/getAccountInfo?apiKey=[xxxxx]&companyName=[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 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

OrderHistory Info API

https://voiceapi.office24by7.com/getOrderHistory?apiKey=[xxxxx]&companyName=[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 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

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

BalanceHistory Info API

https://voiceapi.office24by7.com/getBalanceHistory?apiKey=[xxxxx]&companyName=[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 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

WhiteListContacts 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

BlockListContacts 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]&companyName=[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 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

DataList Info API

https://voiceapi.office24by7.com/getDataList?apiKey=[xxxxx]&companyName=[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 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

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

RealTimeOperators 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
serviceNumber company service number Yes
LoginID 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