Get Templates API

AI Tools

Given the user email address, this API retrieves all the reporting templates created in Jivox studio. The XML returned will have Advertiser name, Template Id and Template Name.

Request URL

http:///jivox/serverAPIs/externalReporting/getTemplates.php

Parameters

Following are the parameters supported by this API:

Parameter	Description
apiId	(Required) ID of the API.
apiKey	(Required) Authentication key.
apiVersion	(Required) Version number of the API for which authentication key is generated.
publisherId	(Required) ID of the publisher or agency for which authentication key is generated.
emailAddress	(Required) email address of the Advertiser account that hosts the custom templates.

Example

Using cURL (this command includes hard returns for readability):

curl -d 'apiId=jivox.reporting.api&apiKey=MyAPIKey&apiVersion=2.0& publisherId=939&userName=myemail@domain.com' http:__testserver.jivox.com_jivox_serverAPIs_externalReporting_getTemplates.php

Server Success Response

In case of success, the server returns xml structure as shown below:

<jivoxServerResponse> <result>SUCCESS<_result> <templates> <template> <template_id>2126<_template_id> <template_name>MyFristTemplate<_template_name> <_template> .. .. <template> .. <templates> <_jivoxServerResponse>

Last updated on

Was this page helpful?