examinare
Iniciar sessão
Escolha o idioma
Iniciar conta Examinare

Examinare API - Visão geral

Comece a usar a API da Ferramenta de Pesquisa Examinare

Tutorial em vídeo sobre como ativar a API Examinare

Ativar Ferramenta de inquéritos Examinare API

Vermelho Dados XML são enviados usando HTTPS como dados POST, mas não são enviados como dados HTML.
No início deste documento há um resumo das funções disponíveis, seguido por uma parte mais detalhada.

O URL para todas as funções é
https://api.examinare.com/framework
Para conectar você precisa adicionar três comandos aos dados POST:

apiKey – Isso é fornecido pela Examinare em sua conta.
apiCompany – O banco de dados da empresa a ser usado.
Comando – O comando que você fornece para a chamada.
Por favor, note: Mais comandos podem ser necessários pela função que você chama.

API móvel e chaves de API não compartilhadas.

Se por algum motivo você quiser manter sua chave de API privada e usar um tipo de estilo de login em vez da chave de API do Examinare estático, então você pode usar o comando Mobile API setPhoneID, este comando pode ser usado para obter um token de API móvel que pode ser usado em vez do token de API estático.  Todos os tokens de API móvel podem ser excluídos a qualquer momento da sua conta Examinare dentro de Configurações -> Configurações Avançadas.

Biblioteca wrapper PHP

Exemplo de PHP 
<?php 
class ExaminareAPIConnector{
public $credentials;
public $command;
public $sendinfo;
public $returnjson=0;

	public function __construct ($apiuser,$apikey,$apiurl){
		if($apiurl==""){$apiurl="api.examinare.com";}
		$url="https://".$apiurl."/framework";
		$companyid=$apiuser;
		$token=$apikey;


		$this->sendinfo['apiKey']=$token;
		$this->sendinfo['apiCompany']=$companyid;
		$this->sendinfo['url']=$url;
		
	}
	public function setCommand($Command){
		$this->sendinfo['Command']=$Command;
	}

	public function Data($sendinfo){
		foreach ($sendinfo as $key => $value)
    	{$this->sendinfo[$key]=$value;}
	}
	public function JsonEnable(){
		$this->returnjson=1;
	}
	public function Execute(){
		$sendinfo=$this->sendinfo;
		$method = "POST";
		$action=$this->sendinfo['url'];
		$fields="";
    	foreach ($sendinfo as $key => $value)
    	{
        	if ($key != 'url')
        	{
            	$fields .= $key . '=' . rawurlencode($value) . '&';
        	}
    	}
			$fields = substr($fields, 0, strlen($fields) - 1);
			$ch = curl_init();
    		curl_setopt($ch, CURLOPT_URL, $action);
    		curl_setopt($ch, CURLOPT_POST, 1);
    		curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
			$result = curl_exec($ch);
			$info_arrays = curl_getinfo($ch);
			curl_close($ch);
			if($result === false ){
				return false;
			}else{
				if($this->returnjson==1){
				return json_decode($result,1);
				}else{
				return $this->toArray(new SimpleXMLElement($result));
				}
			}
			
		}
		
	public function ExecuteRaw(){ // Used to get the raw file from the url.
		$sendinfo=$this->sendinfo;
		$method = "POST";
		$action=$this->sendinfo['url'];
		$fields="";
    	foreach ($sendinfo as $key => $value)
    	{
        	if ($key != 'url')
        	{
            	$fields .= $key . '=' . rawurlencode($value) . '&';
        	}
    	}
			$fields = substr($fields, 0, strlen($fields) - 1);
			$ch = curl_init();
    		curl_setopt($ch, CURLOPT_URL, $action);
    		curl_setopt($ch, CURLOPT_POST, 1);
    		curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
			$result = curl_exec($ch);
			$info_arrays = curl_getinfo($ch);
			curl_close($ch);
			if($result === false ){
				return false;
			}else{
				return $result;
			}
			
		}
	public function toArray($xml) {
        $array = json_decode(json_encode($xml), TRUE);
        
        foreach ( array_slice($array, 0) as $key => $value ) {
            if ( empty($value) ) $array[$key] = NULL;
            elseif ( is_array($value) ) $array[$key] = $this->toArray($value);
        }

        return $array;
    }
}
?>

O código da biblioteca PHP Wrapper.

Sem downloads OU longos ficheiros readme.

Basta copiar e colar onde você quer que o código seja colocado.

Se você escolher o nome do ficheiro “examinare-api.php”, então todos os exemplos de código PHP neste site funcionarão com as URLs.

Caso contrário, você precisa atualizar a declaração de inclusão do código no topo.Nosso wrapper PHP está disponível no GitHub. https://github.com/examinare/examinare-php-wrapper

setPhoneID (Use API móvel)

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?>
<response> 
	<status>Success</status> 
	<tokens>
  		<token>UMOBI:7182101920d9s9f7d8f6d76f7sd8sd98as</token>
  		<cname>CNAME</cname>
	</tokens>
</response>

Com o setPhoneID, você pode criar suas próprias chaves de API que serão conectadas a um utilizador administrativo ao vivo em sua conta Examinare.Você precisa ativar as funções de Chaves Móveis em sua guia Configuração em sua conta Examinare.

Informações de dados POST:
(A informação vermelha é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

apiCompany ID da empresa
user Nome de utilizador dos administradores
pass Administradores Palavra-passe em Criptografia MD5.
deviceInformation Texto opcional para descrever o dispositivo do conector de API, que será exibido na lista de tokens de API em sua conta.

Quer construir soluções baseadas no Examinare?

Oferecemos uma Conta de Desenvolvedor que pode ser usada para criar uma Sandbox ou usada para criar aplicativos externos para a API Examinare, onde seus clientes podem usar sua solução com sua conta Examinare.

A conta de desenvolvedor tem todas as funções de uma conta normal, por causa de seu baixo preço você não pode usar essas contas para uso comercial.

Conta de Desenvolvedor
99 USD
  • Respostas, pesquisas e destinatários ilimitados
  • Publique 1 questionário ao mesmo tempo
  • Biblioteca de modelos prontos
  • Somente Suporte por Email
  • Assinatura anual
  • Examinare Acesso à API
  • Não para uso comercial

Ordem

Inquéritos

clearVotes

Sem pré-visualização

Limpar os votos de uma pesquisa. Vai apagar todos os votos em uma pesquisa, use com cautela!

Informações de dados POST:

(Vermelho informação é obrigatória, preto é opcional), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.

Dados de retorno

Essa chamada de API retornará uma única informação de status se for bem-sucedida, caso contrário, uma mensagem de erro informando que a pesquisa não pode ser encontrada.

copySurvey

Sem pré-visualização

Copia um questionário e retorna informações do questionário recém-criado.

Informações de dados POST:

(Vermelho informação é obrigatória, preto é opcional), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
name Nome da Pesquisa (só será exibido na Conta)

Dados de retorno

Essa chamada de API retornará um único contêiner de pesquisa XML, que conterá as informações, incluindo o surveyID, que serão usadas nas chamadas para a estrutura.

(Veja listSurveys para ajuda com formatação.)

fetchResults

Exemplo de PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("fetchResults");
	
      
                        
	$api2->Data(array("surveyID"=>"REPLACE WITH YOUR SURVEY ID"));
	// Timestamps are not needed but good to use.
	//This example below is for results between 1 january 2015 and 31 december 2015.
	$api2->Data(array("timestamp1"=>1420070400));//01/01/2015 @ 12:00am (UTC)
	$api2->Data(array("timestamp2"=>1451606400));//01/01/2016 @ 12:00am (UTC)
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Survey Results ready to use.*/
                        
?>

Exemplo de saída

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?> 
<response> 
	<status>Success</status> 
	<result> 
		<surveyInfo surveyID="1315983192"> 
			<surveyID>1315983192</surveyID> 
			<surveyCount>2</surveyCount> 
		</surveyInfo>
	</result> 
	<results> 
		<question Number="1"> 
		<questionNumber>1</questionNumber> 
		<questionInfo>
			<questionText>Do you have a Customer Service system in place?||!linebreak!||(A process that ensures a minimum level of service)</questionText>
			<questionType>Multichoise_question</questionType>
			<questionTypeID>1</questionTypeID>
		</questionInfo>
		<alternative>
			<captionText>Yes</captionText>
			<numResult>0</numResult>
		</alternative>
		<alternative>
			<captionText>No</captionText>
			<numResult>2</numResult>
		</alternative>
		</question>
	</results>
</response>


Obtenha os resultados da pesquisa sem filtragem de dados de fundo.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
timestamp1 Usado em combinação com timestamp2 para selecionar votos entre 2 datas.Necessita estar na forma de timestamp UNIX.
timestamp2 Carimbo de hora UNIX.
allowcomments Defina este parâmetro para qualquer coisa retornar os comentários inseridos em perguntas de pesquisas.

fetchResultsByInfoReg

Exemplo de saída

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?> 
<response> 
	<status>Success</status> 
	<result> 
		<surveyInfo surveyID="1315983192"> 
			<surveyID>1315983192</surveyID> 
			<surveyCount>2</surveyCount> 
		</surveyInfo>
	</result> 
	<results> 
		<question Number="1"> 
		<questionNumber>1</questionNumber> 
		<questionInfo>
			<questionText>Do you have a Customer Service system in place?||!linebreak!||(A process that ensures a minimum level of service)</questionText>
			<questionType>Multichoise_question</questionType>
			<questionTypeID>1</questionTypeID>
		</questionInfo>
		<alternative>
			<captionText>Yes</captionText>
			<numResult>0</numResult>
		</alternative>
		<alternative>
			<captionText>No</captionText>
			<numResult>2</numResult>
		</alternative>
		</question>
	</results>
</response>


Obtenha os resultados da pesquisa com ID de transação.

Informações de dados POST:

(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
timestamp1 Usado em combinação com timestamp2 para selecionar votos entre 2 datas.Necessita estar na forma de timestamp UNIX.
timestamp2 Carimbo de hora UNIX.
infoReg ID da transação, pode ser coletado ao usar o retorno automático com trackcode em URL.Contacte o suporte técnico para mais informações.

Wildcard activado => Aplicar * para usar Wildcard. Exemplo : Nisse pode ser “N*e”

fetchResultsByUser

Exemplo de saída

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?> 
<response> 
	<status>Success</status> 
	<result> 
		<surveyInfo surveyID="1315983192"> 
			<surveyID>1315983192</surveyID> 
			<surveyCount>2</surveyCount> 
		</surveyInfo>
	</result> 
	<results> 
		<question Number="1"> 
		<questionNumber>1</questionNumber> 
		<questionInfo>
			<questionText>Do you have a Customer Service system in place?||!linebreak!||(A process that ensures a minimum level of service)</questionText>
			<questionType>Multichoise_question</questionType>
			<questionTypeID>1</questionTypeID>
		</questionInfo>
		<alternative>
			<captionText>Yes</captionText>
			<numResult>0</numResult>
		</alternative>
		<alternative>
			<captionText>No</captionText>
			<numResult>2</numResult>
		</alternative>
		</question>
	</results>
</response>


Obtenha os resultados da pesquisa com filtragem de dados em segundo plano.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
timestamp1 Usado em combinação com timestamp2 para selecionar votos entre 2 datas.Necessita estar na forma de timestamp UNIX.
timestamp2 Carimbo de hora UNIX.
contactID contactID conectado ao destinatário. (Wildcard habilitado)
email E-mail pertencente ao destinatário. (Wildcard habilitado)
group Nome do grupo pertencente ao destinatário. (Wildcard habilitado)
title Título pertencente ao destinatário. (Wildcard habilitado)
company Nome da empresa pertencente ao destinatário. (Wildcard habilitado)
company-title Título da empresa dos destinatários. (Wildcard habilitado)
department Departamento na empresa. (Wildcard habilitado)
customer-group Grupo de clientes. (Wildcard habilitado)
gender Consulte as informações do cliente.
address Endereço (Wildcard habilitado)
state Estado (Wildcard habilitado)
country País (Wildcard habilitado)
city Cidade (Wildcard habilitado)
postal-code Código postal (Wildcard habilitado)

Wildcard activado => Aplicar * para usar Wildcard. Exemplo : Nisse pode ser N*e

getRecipientsBasedByResults

Sem pré-visualização

Esta função usa o mesmo indata como o fetchResultsByUser e mostra os destinatários que responderam com base em in-data.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
timestamp1 Usado em combinação com timestamp2 para selecionar votos entre 2 datas.Necessita estar na forma de timestamp UNIX.
timestamp2 Carimbo de hora UNIX.
contactID contactID conectado ao destinatário. (Wildcard habilitado)
email E-mail pertencente ao destinatário. (Wildcard habilitado)
group Nome do grupo pertencente ao destinatário. (Wildcard habilitado)
title Título pertencente ao destinatário. (Wildcard habilitado)
company Nome da empresa pertencente ao destinatário. (Wildcard habilitado)
company-title Título da empresa dos destinatários. (Wildcard habilitado)
department Departamento na empresa. (Wildcard habilitado)
customer-group Grupo de clientes. (Wildcard habilitado)
gender Consulte as informações do cliente.
address Endereço (Wildcard habilitado)
state Estado (Wildcard habilitado)
country País (Wildcard habilitado)
city Cidade (Wildcard habilitado)
postal-code Código postal (Wildcard habilitado)

Wildcard activado => Aplicar * para usar Wildcard. Exemplo : Nisse pode ser N*e

importSurvey

Sem pré-visualização

Importe o ficheiro Examinare para sua conta.

Informações de dados POST:
(A informação vermelha é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

examinarexml Conteúdo do ficheiro do Examinare Survey File (.examinare)

Por favor, note: Recomendamos apenas enviar um ficheiro de pesquisa Examinare pré-formatado ou traduzido para o sistema. 

Se você alterar a estrutura do ficheiro, pode criar um erro ao usar o questionário.Se você traduzir o ficheiro, certifique-se de usar a função de tradução dentro da ferramenta.

listSurveys

Exemplo de saída

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?>
<response> 
<status>Status</status>
 <surveys>
  <surveyInfo surveyID=”surveyID”>
  	<surveyID>829128191289</surveyID>
	<surveyName>Survey name</ surveyName>
	<surveyTaggName>Name of the tag</surveyTaggName>
	<status>Public survey</status>
	<surveyLinkWeb>{URL}</surveyLinkWeb>
	<surveyLinkMobile>{URL}</surveyLinkMobile>
	<completedAnswers>150</completedAnswers>
	<stoppedAnswers>0</stoppedAnswers>
	<surveyLanguage>sv</surveyLanguage>
  </surveyInfo>
 </surveys>
</response>


Informações de dados POST:
Esta função não precisa de nenhum dado POST extra.

Dados de retorno

Essa chamada de API retornará um contêiner de pesquisa XML múltiplo, que conterá as informações, incluindo o surveyID, que serão usadas nas chamadas para a estrutura.

questionsInSurveys

Exemplo de saída

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?>
	<response>
		<status>Success</status>
		<survey> 
			<surveyInfosurveyID="1315983192">
				<surveyID>1315983192</surveyID>
			</surveyInfo> 
		</survey> 
		<questions> 
		  <question Number="1">
			<questionNumber>1</questionNumber>
			<questionText>Do you have a Customer Service system in place?||!linebreak!||(A process that ensures a minimum level of service)</questionText>
			<InstructionText></InstructionText>
			<InstructionPos></InstructionPos>
			<questionType>Multichoise_question</questionType>
			<alternative>
				<alternativeID>1</alternativeID>
				<captionText>Yes</captionText>
			</alternative>
			<alternative>
				<alternativeID>2</alternativeID>
				<captionText>No</captionText>
			</alternative>
		  </question>
		</questions>
	</response>

Obter todas as perguntas de um questionário.

Informações de dados POST:
(A informação vermelha é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.

searchFreeText

Sem código de pré-visualização

Informações de dados POST:
(A informação vermelha é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID SurveyID da pesquisa que você deseja pesquisar
Text Frase que você deseja pesquisar. Wildcard (*) habilitado.

sendMessageEmail

PHP Exemplo de Código

Exemplo de PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("sendMessageEmail");
	$details = Array();
	$details["user_1"]="ContactID";
    $details["delivery_message"]=$emailmessage["body"];
	$details["delivery_subject"]=$emailmessage["subject"];	
	
	
                        
	$api2->Data($details);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the send ID.*/
                        
?>
Exemplo de saída 
<?xml version="1.0" encoding="utf-8"?>
<response>
	<status>Success</status>
	<reports>
		<report>
			<contactID>UA1317237650U4e8373923c16b</contactID>
			<status>ADDED</status>
		</report>
		<report>
			<contactID>UE1317299990U4e8373923c70c</contactID>
			<status>ERROR</status>
		</report>
	</reports>
</response>

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

user_ * contactID das informações de contato. * precisa ser alterado para números, por exemplo user_1, user_2 etc.
delivery_message Mensagem a ser enviada por Email. Máximo de 220 caracteres.
delivery_subject Assunto da mensagem.
rtl Use a codificação RTL para árabe e hebraico. Defina 1 para sim ou não definir para não.
includelogo Use o logotipo no banner superior. Defina 1 para sim ou não definir para não.

sendMessageSMS

PHP Exemplo de Código 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("sendMessageSMS");
	$details = Array();
	$details["user_1"]="ContactID";
    $details["delivery_message"]=$emailmessage["body"];
	$details["delivery_subject"]=$emailmessage["subject"];	
	$details["delivery_by"]="SMS";// Must be set otherwise it will be sent by Email.
	
                        
	$api2->Data($details);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the send ID.*/
                        
?>
Exemplo de saída 
<?xml version="1.0" encoding="utf-8"?>
<response>
	<status>Success</status>
	<reports>
		<report>
			<contactID>UA1317237650U4e8373923c16b</contactID>
			<status>ADDED</status>
		</report>
		<report>
			<contactID>UE1317299990U4e8373923c70c</contactID>
			<status>ERROR</status>
		</report>
	</reports>
</response>

Enviar mensagem SMS para os destinatários.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

user_ * contactID das informações de contato. * precisa ser alterado para números, por exemplo user_1, user_2 etc.
delivery_message Mensagem a ser enviada por SMS. Máximo de 220 caracteres.
rtl Use a codificação RTL para árabe e hebraico. Defina 1 para sim ou não definir para não.

Observe: Esta mensagem não terá um link para uma Pesquisa ou Poll, se você quiser adicionar um link para uma Pesquisa use a API Call chamada “sendSurvey (SMS)”.

sendSurvey (Email)

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("sendSurvey");
	$details = Array();
	$details["surveyID"]="SURVEYID";
	$details["user_1"]="ContactID";
    $details["delivery_message"]=$emailmessage["body"];
	$details["delivery_subject"]=$emailmessage["subject"];	
	
	
                        
	$api2->Data($details);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the send ID.*/
                        
?>
Saída da amostra 
<?xml version="1.0" encoding="utf-8"?>
<response> 
<status>Success</status>
<reports> 
	<report> 
		<contactID>UA1317237650U4e8373923c16b</contactID>
 		<status>ADDED</status>
  	</report>
   <report>
   		<contactID>UE1317299990U4e8373923c70c</contactID>
   		<status>ERROR</status>
   </report>
</reports>
</response>

Envie convites por e-mail aos destinatários.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
user_ * contactID das informações de contato. * precisa ser alterado para números, por exemplo user_1, user_2 etc.
delivery_message Mensagem a ser enviada por Email. Máximo de 220 caracteres.
delivery_subject Assunto da mensagem.
includelogo Use o logotipo no banner superior. Defina 1 para sim ou não definir para não.
schedule Agende este email para entrega posterior. Deve conter um carimbo de data/hora UNIX

sendSurvey (SMS)

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("sendSurvey");
	$details = Array();
	$details["surveyID"]="SURVEYID";
	$details["user_1"]="ContactID";
    $details["delivery_message"]=$emailmessage["body"];
	$details["delivery_subject"]=$emailmessage["subject"];	
	$details["delivery_by"]="SMS";// Must be set otherwise it will be sent by Email.
	
                        
	$api2->Data($details);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the send ID.*/
                        
?>
Saída da amostra 
<?xml version="1.0" encoding="utf-8"?>
<response> 
<status>Success</status>
<reports> 
	<report> 
		<contactID>UA1317237650U4e8373923c16b</contactID>
 		<status>ADDED</status>
  	</report>
   <report>
   		<contactID>UE1317299990U4e8373923c70c</contactID>
   		<status>ERROR</status>
   </report>
</reports>
</response>

Envie convites por SMS aos destinatários.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
user_ * contactID das informações de contato. * precisa ser alterado para números, por exemplo user_1, user_2 etc.
delivery_message Mensagem a ser enviada por SMS.
delivery_by Deve ser definido como SMS.
schedule Agende este SMS para entrega posterior. Deve conter um carimbo de data/hora UNIX

updateInstructionText

Sem pré-visualização

Atualize o Texto Instrucional com QuestionNumber no Survey.

Informações de dados POST:
(Vermelho informação é obrigatória, preto é opcional), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID SurveyID, veja listSurveys para mais informações
instructionText Novo Texto Instrucional para esta Pergunta. (Aplicar ||!linebreak!|| em vez de quebras de linha)
questionNumber Número da pergunta encontrado em listSurveys.

Dados de retorno

Esta chamada de API retornará uma resposta XML com status Success se for atualizada, error se um erro foi chamado.Lista de estrutura será retornada, veja questionInSurveys para mais informações sobre estrutura.

updateQuestionText

Sem pré-visualização

Atualize o texto das perguntas com QuestionNumber no Survey.

Informações de dados POST:
(Vermelho informação é obrigatória, preto é opcional), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID SurveyID, veja listSurveys para mais informações
questionText Nova pergunta desta pesquisa. (Aplique ||!linebreak!|| em vez de quebras de linha)
questionNumber Número da pergunta encontrado em listSurveys.

Dados de retorno

Esta chamada de API retornará uma resposta XML com status Success se for atualizada, error se um erro foi chamado.Lista de estrutura será retornada, veja questionInSurveys para mais informações sobre estrutura.

Destinatários

addRecipient

Dados de retorno

Essa chamada de API retornará uma resposta XML com status Sucesso se for criada, erro se um erro tiver sido chamado.O contêiner de contatos XML conterá as informações, incluindo o contactID que será usado em suas chamadas para a estrutura.

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("addRecipient");
	$recipient_r = Array();
                        
	$recipient_r["name"]="My name";
	$recipient_r["email"]="myname@mydomain.com";
	$recipient_r["group"]="My Group";
                        
	$api2->Data($recipient_r);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipient record to use.*/
                        
?>
Saída da amostra 
<?xml version="1.0" encoding="utf-8"?>
 <response> 
 <status>Status</status>
 <contacts> 
 <contact cid="contactID">
    <contactID>829128191289</contactID>
      	<authCode>829108</authCode>
		<name>Name</name>
		<lastname>Last name</lastname>
		<email>info@domain.com</email>
		<mobile>+467031234567</mobile>
		<group>Groupname</group>
		<title>Mr</title>
		<company>Company name</company>
		<company-title>Company name</company-title>
		<department>Sales</department>
		<customer-group>Sales groups</customer-group>
		<gender>male</gender>
		<birth-year>1919</birth-year>
		<birth-month>1919</birth-month>
		<birth-day>1919</birth-day>
		<phonenumber>+46844444444</ phonenumber>
		<attention>Attention</attention>
		<address>Adress</address>
		<city>Kristianstad</city>
		<postal-code>29184</postal-code>
		<state>Skane</state>
		<country>Sweden</country>
		<crmserial>15001</crmserial>		
		<extrafields>
			<extrafield>
				<key>f54601af5d3377</key>
				<value>Testar åäö</value>
			</extrafield>
			<extrafield>
				<key>f5461293d9b22d</key>
				<value></value>
			</extrafield>
			<extrafield>
				<key>f5460eb07e2f93</key>
				<value>7</value>
			</extrafield>
		</extrafields>
	</contact>
</contacts>
</response>

Adicionar destinatário ao banco de dados da empresa.

Informações de dados POST:

(Vermelho informação é obrigatória, preto é opcional), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

name Nome do destinatário.
lastname Sobrenome do destinatário.
email Email do destinatário.
mobile Número de telemóvel. (Formato 00[código do país][código de área][número de telefone])Exemplo : 00467031234567
group Nome do grupo.
title Título pessoal.
company Nome da empresa.
company-title Título da empresa do destinatário.
department Departamento em Empresa.
customer-group Grupo de clientes.
gender Gênero do destinatário. (masculino para Masculino, feminino para Feminino).
birth-year Ano de nascimento (AAAA), apenas dígitos.
birth-month Mês de nascimento (MM), apenas dígitos.
birth-day Data de nascimento (DD), apenas dígitos.
phonenumber Número de telefone do destinatário.
attention Endereço de atenção do destinatário.
address Endereço do destinatário.
city Nome da cidade.
state Nome do estado.
postal-code Código postal.
country Nome do país
crmserial Serial do módulo de integração para ex. Zendesk ticket ID.
extrafieldkey Chave de extrafields no formato abaixo.

delRecipient

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("delRecipient");
	                        
	$api2->Data(array("contactID"=>"Change with ContactID from Examinare"));
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any.*/
                        
?>

Exclui um destinatário no banco de dados da empresa.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

contactID ID de contato do seu banco de dados Examinare.

Dados de retorno

Essa chamada de API retornará uma resposta XML com status Sucesso se for excluída, erro se um erro tiver sido chamado.

listRecipientByContactID

Dados de retorno

Essa chamada de API retornará um único contêiner de contatos XML. O contêiner de contatos XML conterá as informações, incluindo o contactID, que serão usadas em suas chamadas para a estrutura. (Consulte addRecipient)

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientByContactID");
	 
                        
	$api2->Data(array("contactID"=>"ContactID of your Survey in Examinare"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>

Listar informações de um único destinatário usando o contactID do destinatário.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

contactID ID de contato do seu banco de dados Examinare.

listRecipientByCRMSerial

Dados de retorno

Essa chamada de API retornará um único contêiner de contatos XML. O contêiner de contatos XML conterá as informações, incluindo o contactID, que serão usadas em suas chamadas para a estrutura. Observe que essa chamada pode retornar vários contatos (consulte addRecipient).

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientByCRMSerial");
	
      /* Example for the Zendesk ticket id 1*/ 
                        
	$api2->Data(array("crmserial"=>"Zendesk:1"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>

Liste as informações de um único destinatário com a ajuda do CRM Serial que é criado nas extensões Examinare disponíveis.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

crmserial Crm Serial incluindo estrutura de plugin. Verifique a ecrã do destinatário para detalhes.

listRecipientByEmail

Dados de retorno

Essa chamada de API retornará um único contêiner de contatos XML. O contêiner de contatos XML conterá as informações, incluindo o contactID, que serão usadas em suas chamadas para a estrutura. Observe que essa chamada pode retornar vários contatos (consulte addRecipient).

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientByEmail");
	
      
                        
	$api2->Data(array("email"=>"my@email.xxx"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>

Listar informações de um único destinatário usando o email do destinatário.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

email Endereço de Email de Contato do seu banco de dados Examinare.

listRecipients

Dados de retorno

Essa chamada de API retornará um contêiner de vários contatos XML. O contêiner de contatos XML conterá as informações, incluindo o contactID, que serão usadas em suas chamadas para a estrutura. (Veja addRecipient)

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipients");
	 
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the all Recipients in an array.*/
                        
?>

Obtenha uma lista completa de todos os destinatários em seu banco de dados Examinare.

Informações de dados POST:

Esta função não precisa de nenhum dado POST extra.

listRecipientsByGroup

Dados de retorno

Essa chamada de API retornará um único contêiner de contatos XML. O contêiner de contatos XML conterá as informações, incluindo o contactID, que serão usadas em suas chamadas para a estrutura. (Consulte addRecipient)

informações, incluindo o contactID que será usado em suas chamadas para o framework (Veja addRecipient).

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientsByGroup");
	
      
                        
	$api2->Data(array("group"=>"Name of your Group in Examinare"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>

Listar informações de destinatários por nome de grupo.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

group Nome do grupo

listRecipientsExtraFields

informações, incluindo o contactID que será usado em suas chamadas para o framework (Veja addRecipient).

Exemplo de código PHP 
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>Success</status>
<extrafields>
	<extrafield>
		<key>f54601af5d3377</key>
		<caption>Field1</caption>
		<type>text</type>
		<options></options>
	</extrafield>
	<extrafield>
		<key>f5461293d9b22d</key>
		<caption>Field3</caption>
		<type>checkbox</type>
		<options></options>
	</extrafield>
	<extrafield>
		<key>f5460eb07e2f93</key>
		<caption>Testing</caption>
		<type>select</type>
		<options>
			<option>1</option>
			<option>2</option>
			<option>3</option>
			<option>4</option>
			<option>5</option>
			<option>6</option>
			<option>7</option>
			<option>8</option>
			<option>9</option>
			<option>10</option>
		</options>
	</extrafield>
</extrafields>
</response>

O perfil dos destinatários pode ser estendido com campos extras e estes são enviados ao adicionar, carregar, atualizar destinatários.

Informações de dados POST:

Esta função não aceita nenhum parâmetro POST.

Dados de retorno

key Chave usada nos dados do destinatário.
caption Legenda do campo das Configurações do Examinare.
type Tipo de campo, (selecionar, texto, caixa de seleção)
options Opções ao usar o tipo de campo selecionado.

listRecipientsToSurvey

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientsToSurvey");
	 
                        
	$api2->Data(array("surveyID"=>"Survey ID of your Survey in Examinare"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>
Exemplo de saída 
<?xml version=”1.0" encoding=”utf-8"?> 
<response> 
	<status>Success</status> 
	<contacts>
		<contact cid=”UI1317137541U4e81ec85c8c61">
			<contactID>UI1317137541U4e81ec85c8c61</contactID>
			<authCode>258848</authCode>
			<name>Peter</name>
			<lastname>Lastname</lastname>
			<email>peter@domain.com</email>
			<mobile>+4670000000</mobile>
			<group>Customer Service Rating</group>
			<title></title>
			<company></company>
			<company-title></company-title>
			<department></department>
			<customer-group></customer-group>
			<gender>none</gender>
			<birth-year></birth-year>
			<birth-month></birth-month>
			<birth-day></birth-day>
			<phonenumber></phonenumber>
			<attention></attention>
			<address></address>
			<city></city>
			<postal-code></postal-code>
			<state></state>
			<country></country>
			<surveyLinkWeb>LINK</surveyLinkWeb>
			<surveyLinkMobile>LINK</surveyLinkMobile>
			<surveyStatus>ANSWERED</surveyStatus>
		</contact>
	</contacts>
</response>

Lista todos os links de destinatários e status dos convites enviados pelo Examinare.

Observação: Apenas pesquisas anônimas e privadas podem ser usadas com este comando.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.

listSurveysByUser

Dados de retorno

Essa chamada de API retornará um contêiner de pesquisa XML múltiplo, que conterá as informações, incluindo o surveyID, que serão usadas nas chamadas para a estrutura.

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listSurveysByUser");
	 
	$api2->Data(array("contactID"=>"Contact ID in Examinare"));
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the contact information with all Surveys in an array.*/
                        
?>

Listar todos os questionários conectados a um destinatário e status.

Informações de dados POST

(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

contactID ID de contato do seu banco de dados Examinare.

markRecipientsToSurvey

Exemplo de saída 
<?xml version="1.0" encoding="utf-8"?>
<response> 
 <status>Success</status>
 <reports> 
 	<report> 
 		<contactID>UA1317237650U4e8373923c16b</contactID>
  		<status>MARKED</status>
   </report>
  </reports>
</response>

Marque os destinatários como convidados para uma única pesquisa no registro de status Examinare.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
user_ * contactID das informações de contato. * precisa ser alterado para números, por exemplo user_1, user_2 etc.

listSurveysByUser

Dados de retorno

Essa chamada de API retornará um contêiner de pesquisa XML múltiplo, que conterá as informações, incluindo o surveyID, que serão usadas nas chamadas para a estrutura.

Exemplo de código PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listSurveysByUser");
	 
	$api2->Data(array("contactID"=>"Contact ID in Examinare"));
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the contact information with all Surveys in an array.*/
                        
?>
Saída da amostra 
<?xml version="1.0" encoding="utf-8"?>
<response> 
	<status>Success</status> 
	<contacts> 
	 <contact cid="UQ1289426855U4cdb17a7dde8c"> 
		<contactID>UQ1289426855U4cdb17a7dde8c</contactID> 
		<authCode>178059</authCode> 
		<name>John</name>
		<lastname>Doe</lastname> 
		<email>info@email.go</email> 
		<mobile></mobile> 
		<group>Facebook</group> 
		<title>none</title> 
		<company></company> 
		<company-title></company-title> 
		<department></department> 
		<customer-group>Facebook</customer-group> 
		<gender>man</gender> 
		<birth-year>2002</birth-year> 
		<birth-month>01</birth-month> 
		<birth-day>02</birth-day> 
		<phonenumber></phonenumber> 
		<attention></attention> 
		<address></address> 
		<city></city> 
		<postal-code></postal-code> 
		<state></state> 
		<country>en_US</country> 
		<surveys> 
		 <surveyInfo surveyID="1321866201"> 
			<surveyID>1321866201</surveyID> 
			<surveyName>Survey1</surveyName> 
			<surveyTaggName></surveyTaggName> 
			<completed>FALSE</completed> 
			<attending>TRUE</attending> 
			<surveyLinkWeb>URL</surveyLinkWeb> 
			<surveyLinkMobile>URL</surveyLinkMobile> 
			<surveyLanguage>th</surveyLanguage> </surveyInfo> 
			<surveyInfo surveyID="1260279826"> 
			<surveyID>1260279826</surveyID> 
			<surveyName>Survey2</surveyName> 
			<surveyTaggName></surveyTaggName> 
			<completed>FALSE</completed> 
			<attending>FALSE</attending> 
			<surveyLinkWeb>URL</surveyLinkWeb> 
			<surveyLinkMobile>URL</surveyLinkMobile> 
			<surveyLanguage>hi</surveyLanguage> 
		 </surveyInfo> 
		</surveys> 
	 </contact>
	</contacts>  

</response>

Listar todos os questionários conectados a um destinatário e status.

Informações de dados POST

(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

contactID ID de contato do seu banco de dados Examinare.

markRecipientsToSurvey

Sem pré-visualização

Marque os destinatários como convidados para uma única pesquisa no registro de status Examinare.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
user_ * contactID das informações de contato. * precisa ser alterado para números, por exemplo user_1, user_2 etc.

updateGenderRecipient

Dados de retorno

Essa chamada de API retornará uma resposta XML com o status Sucesso se for atualizada, erro se um erro tiver sido chamado. O contêiner de contatos XML conterá as informações, incluindo o contactID que será usado em suas chamadas para a estrutura. (Veja addRecipient)

Por favor, note que o exemplo abaixo é para addrecipient e precisa ser ajustado para usar a função de atualização.

Saída da amostra

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?>
 <response> 
 <status>Status</status>
 <contacts> 
 <contact cid="contactID">
    <contactID>829128191289</contactID>
      	<authCode>829108</authCode>
		<name>Name</name>
		<lastname>Last name</lastname>
		<email>info@domain.com</email>
		<mobile>+467031234567</mobile>
		<group>Groupname</group>
		<title>Mr</title>
		<company>Company name</company>
		<company-title>Company name</company-title>
		<department>Sales</department>
		<customer-group>Sales groups</customer-group>
		<gender>male</gender>
		<birth-year>1919</birth-year>
		<birth-month>1919</birth-month>
		<birth-day>1919</birth-day>
		<phonenumber>+46844444444</ phonenumber>
		<attention>Attention</attention>
		<address>Adress</address>
		<city>Kristianstad</city>
		<postal-code>29184</postal-code>
		<state>Skane</state>
		<country>Sweden</country>
		<crmserial>15001</crmserial>		
		<extrafields>
			<extrafield>
				<key>f54601af5d3377</key>
				<value>Testar åäö</value>
			</extrafield>
			<extrafield>
				<key>f5461293d9b22d</key>
				<value></value>
			</extrafield>
			<extrafield>
				<key>f5460eb07e2f93</key>
				<value>7</value>
			</extrafield>
		</extrafields>
	</contact>
</contacts>
</response>

Atualize as informações de gênero para um único destinatário.

Informações de dados POST:

(Vermelho informação é obrigatória, preto é opcional), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

contactID ID de contato do seu banco de dados Examinare.
gender Gênero do destinatário. (masculino para Masculino, feminino para Feminino).

updateRecipient

Dados de retorno

Essa chamada de API retornará uma resposta XML com status Sucesso se for atualizada, erro se um erro tiver sido chamado. O contêiner de contatos XML conterá as informações, incluindo o contactID, que será usado em suas chamadas para a estrutura. addRecipient)

Por favor, note que o exemplo abaixo é para addrecipient e precisa ser ajustado para usar a função de atualização.

Saída da amostra

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?>
 <response> 
 <status>Status</status>
 <contacts> 
 <contact cid="contactID">
    <contactID>829128191289</contactID>
      	<authCode>829108</authCode>
		<name>Name</name>
		<lastname>Last name</lastname>
		<email>info@domain.com</email>
		<mobile>+467031234567</mobile>
		<group>Groupname</group>
		<title>Mr</title>
		<company>Company name</company>
		<company-title>Company name</company-title>
		<department>Sales</department>
		<customer-group>Sales groups</customer-group>
		<gender>male</gender>
		<birth-year>1919</birth-year>
		<birth-month>1919</birth-month>
		<birth-day>1919</birth-day>
		<phonenumber>+46844444444</ phonenumber>
		<attention>Attention</attention>
		<address>Adress</address>
		<city>Kristianstad</city>
		<postal-code>29184</postal-code>
		<state>Skane</state>
		<country>Sweden</country>
		<crmserial>15001</crmserial>		
		<extrafields>
			<extrafield>
				<key>f54601af5d3377</key>
				<value>Testar åäö</value>
			</extrafield>
			<extrafield>
				<key>f5461293d9b22d</key>
				<value></value>
			</extrafield>
			<extrafield>
				<key>f5460eb07e2f93</key>
				<value>7</value>
			</extrafield>
		</extrafields>
	</contact>
</contacts>
</response>

Atualize as informações dos destinatários no banco de dados Examinare.

Informações de dados POST:

(Vermelho informação é obrigatória, preto é opcional), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

contactID ID de contato do seu banco de dados Examinare.
name Nome do destinatário.
lastname Sobrenome do destinatário.
email Email do destinatário.
mobile Número de telemóvel. (Formato 00[código do país][código de área][número de telefone])Exemplo : 00467031234567
group Nome do grupo.
title Título pessoal.
company Nome da empresa.
company-title Título da empresa do destinatário.
department Departamento em Empresa.
customer-group Grupo de clientes.
gender Gênero do destinatário. (masculino para Masculino, feminino para Feminino).
birth-year Ano de nascimento (AAAA), apenas dígitos.
birth-month Mês de nascimento (MM), apenas dígitos.
birth-day Data de nascimento (DD), apenas dígitos.
phonenumber Número de telefone do destinatário.
attention Endereço de atenção do destinatário.
address Endereço do destinatário.
city Nome da cidade.
state Nome do estado.
postal-code Código postal.
country Nome do país
extrafieldkey Chave de extrafields.

Ficheiros de relatório de pesquisa

fetchReportFile

Exemplo de PHP

Exemplo de PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api->setCommand("fetchResults");
	
      $api->setCommand("fetchReportFileList");
	
	$api->Data(array('surveyID'=>"SURVEYID GOES HERE", "reportID" => 'REPORT ID FROM fetchReportFileList goes here.');
    
			$file =  $api->ExecuteRaw();
			$quoted = "FILE NAME GOES HERE . extension";
			header('Content-Description: File Transfer');
			header('Content-Type: application/octet-stream');
			header('Content-Disposition: attachment; filename=' . $quoted); 
			header('Content-Transfer-Encoding: binary');
			header('Connection: Keep-Alive');
			header('Expires: 0');
			header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
			header('Pragma: public');
			header('Content-Length: ' . strlen($file));			
	
			echo $file;
	
						
                        
	/* In $reports_r you will now find all 
	returnable errors if any or the Report File ID's ready to use with fetchReportFile.*/
                        
?>

Saída da amostra

Exemplo de código 
RAW FILE CONTENT

Obtenha um relatório de sua conta com as informações de fetchReportFileList.

ATENÇÃO: Esta função retorna o ficheiro real com cabeçalhos e NÃO uma estrutura XML.Certifique-se de atualizar seu wrapper para a versão mais recente para ser habilitado a usar o PHP Wrapper para esta função.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
reportID Id do relatório da função fetchReportFileList.

fetchReportFileList

Exemplo de PHP

Exemplo de PHP 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api->setCommand("fetchResults");
	
      $api->setCommand("fetchReportFileList");
	
	$api->Data(array('surveyID'=>"1314773374");
         
						
	$reports_r=$api->Execute();
						
                        
	/* In $reports_r you will now find all 
	returnable errors if any or the Report File ID's ready to use with fetchReportFile.*/
                        
?>

Saída da amostra

Exemplo de XML 
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>Success</status>
<surveys><surveyInfo surveyID="1314773374">
<surveyID>1314773374</surveyID>
<surveyName>Company Service Rating</surveyName>
<surveyTaggName></surveyTaggName>
<reportUrls>
<reportUrl>
	<reportID>mainexcel</reportID>
	<name>Company Service Rating - Main Report.xls</name>
</reportUrl>
<reportUrl>
	<reportID>maindocx</reportID>
	<name>Company Service Rating - Main Report.docx</name>
</reportUrl>
<reportUrl>
	<reportID>mainpdf</reportID>
	<name>Company Service Rating - Main Report.pdf</name>
</reportUrl>
<reportUrl>
	<reportID>rawspss</reportID>
	<name>Company Service Rating - Raw.sps</name>
</reportUrl>
</reportUrls>
</surveyInfo>
</surveys>
</response>

Obtenha a lista de relatórios do Survey para usar com a função fetchReportFile.

Informações de dados POST:
(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.

Magic Polls

fetchMagicPollSummary

Retorno da amostra 1 
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>Success</status>
 <MagicPolls>
  <MagicPollInfo magicID="1365745486">
  <magicID>1365745486</magicID>
  <magicName>Magic Poll Question</magicName>
  <completedAnswers>
	<Summary>0</Summary>
	<Options>
		<Option>
			<Number>1</Number>
			<OptionText>Option 1</OptionText>
			<Result>0</Result>
			<Percent></Percent>
		</Option>
		<Option>
			<Number>2</Number>
			<OptionText>Option 2</OptionText>
			<Result>0</Result>
			<Percent></Percent>
		</Option>
	</Options>
  </completedAnswers>
  <stoppedAnswers>
		<Summary>0</Summary>
  </stoppedAnswers>
  </MagicPollInfo>
 </MagicPolls>
</response>
Retorno da amostra 2 
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>Success</status>
<MagicPolls>
<MagicPollInfo magicID="1365745486">
<magicID>1365745486</magicID>
<magicName>TestPoll</magicName>
<completedAnswers>
	<Summary>5</Summary>
<Options>
	<Option>
		<Number>1</Number>
		<OptionText>Option 1</OptionText>
		<Result>2</Result>
		<Percent>40</Percent>
	</Option>
	<Option>
		<Number>2</Number>
		<OptionText>Option 2</OptionText>
		<Result>3</Result>
		<Percent>60</Percent>
	</Option>
</Options>
  <SMS>
	<answer>
		<id>MOBILE;+46XXXXXXXX.1381480943</id>
		<when>2013-10-11 10:42:23</when>
		<stamp>1381480943</stamp>
		<phrase>2</phrase>
		<from>+46XXXXXXXX</from>
	</answer>
	<answer>
		<id>MOBILE;+46XXXXXXXX.1381479624</id>
		<when>2013-10-11 10:20:24</when>
		<stamp>1381479624</stamp>
		<phrase>2</phrase>
		<from>+46XXXXXXXX</from>
	</answer>
	<answer>
		<id>MOBILE;+46XXXXXXXX.1381479600</id>
		<when>2013-10-11 10:20:00</when>
		<stamp>1381479600</stamp>
		<phrase>1</phrase>
		<from>+46XXXXXXXX</from>
	</answer>
  </SMS>
  <Web>
	<answer>
		<id>WEBSITE;j186hntcn28efok6t6oeg94fv5;XXX.XXX.XXX.XXX.1381479661</id>
		<when>2013-10-11 10:21:01</when>
		<stamp>1381479661</stamp>
		<phrase>Option 2</phrase>
		<from>http://XXX.examinare.net/mp/1365745486/</from>
		<ip>XXX.XXX.XXX.XXX</ip>
	</answer>
  </Web>
 </completedAnswers>
 <stoppedAnswers>
	<Summary>0</Summary>
 </stoppedAnswers>
</MagicPollInfo>
</MagicPolls>
</response>

Informações de dados POST:
Esta função pode ser usada com uma chave POST opcional chamada magicID.Quando magicID é definido, resultados mais detalhados são adicionados ao retorno XML.

Dados de retorno

Essa chamada de API retornará um contêiner XML Magic Poll múltiplo se magicID não estiver definido (Sample return 1).

Se magicID for definido, ele retornará informações mais detalhadas (Retorno de amostra 2).

Retorno da amostra 1

Ver amostra de retorno 1

Informação chave 1

 magicID Id da Pesquisa Mágica no Examinare.
magicName A pergunta feita.
completedAnswers Respostas concluídas na pesquisa.
Options Opções com os resultados da enquete. Se adicionado Opções. Se nenhuma opção este campo está vazio.
–       Number Número de identificação da Opção Polls.
–       Optiontext Texto da Opção de Enquetes
–       Result O resultado da Opção de Enquete
–       Percent A porcentagem da opção de pesquisa em comparação com o resumo das respostas concluídas.

Retorno da amostra 2

Ver amostra de retorno 2

Informação chave 2

Para campos genéricos nesta seção, verifique a Informação chave 1, pois esta parte lida apenas com a diferença entre a informação chave 1 e 2.

 SMS Recipiente para SMS votos
–       Answer Recipiente para resposta SMS individual.
–       – id Id deste voto no Examinare.
–       – when Data da votação no formato Y-M-D Hora
–       – stamp Unix Timestamp da votação
–       – phrase Frase enviada.
–       – from Número de telefone de quem o enviou.
 Web Contenedor para votos na Web
–       Answer Recipiente para votos individuais na Web.
–       – id Id deste voto no Examinare.
–       – when Data da votação no formato Y-M-D Hora
–       – stamp Unix Timestamp da votação
–       – phrase Frase enviada.
–       – from URL do formulário de votação.
–       – ip Endereço IP do dispositivo que entra na votação.

voteMagicPoll

Sem pré-visualização

Informações de dados POST:

magicID Id da Pesquisa Mágica no Examinare.
Option Número chamado dentro do fetchMagicPollSummary (Opcional mas recomendado)
Text Resposta de texto livre. (Opcional, mas recomendado)
GadgetID Você pode definir o GadgetID (texto livre) para que você possa rastrear de onde o voto está vindo (opcional).

Dados de retorno

Esta função retornará Status = OK em caso de sucesso e Status = Error quando um erro ocorreu.

Phone Surveys

listPhoneSurveys

Dados de retorno

Essa chamada de API retornará um contêiner de pesquisa XML múltiplo, que conterá as informações, incluindo o surveyID, que serão usadas nas chamadas para a estrutura.

Saída da amostra 
<?xml version="1.0" encoding="utf-8"?><response>
<status>Success</status>
<surveys>
	<surveyInfo surveyID="1379659109">
		<surveyID>1379659109</surveyID>
		<surveyName>Outbound Phone Survey</surveyName>
		<surveyTaggName></surveyTaggName>
		<status>Outbound</status>
		<callerIDs>
			<callerID>+46188008080</callerID>
			<callerID>+46703121234</callerID>
			<callerID>+46855926800</callerID>
			<callerID>+61865558135</callerID>
			<callerID>+6624028269</callerID>
			<callerID>+14088894369</callerID>
			<callerID>+46840809736</callerID>
		</callerIDs>
		<completedAnswers>6</completedAnswers>
		<stoppedAnswers>0</stoppedAnswers>
		<surveyLanguage>sv</surveyLanguage>
	</surveyInfo>
	<surveyInfo surveyID="1390898671">
		<surveyID>1390898671</surveyID>
		<surveyName>Inbound Phone Survey</surveyName>
		<surveyTaggName></surveyTaggName>
		<status>Inbound</status>
		<phoneNumbers>
		  <phoneNumber>
			<to>+46188008020</to>
			<from>*</from>
		  </phoneNumber>
		</phoneNumbers>
		<completedAnswers>9</completedAnswers>
		<stoppedAnswers>0</stoppedAnswers>
		<surveyLanguage>en</surveyLanguage>
	</surveyInfo>
</surveys>
</response>

Lista todas as pesquisas que foram publicadas como uma pesquisa telefônica e o status delas.

Informações de dados POST:
Esta função não precisa de nenhum dado POST extra.

Informação chave

surveyID Id da pesquisa no Examinare.
surveyName Nome da pesquisa telefônica.
surveyTaggName Tag usada no Examinare.
status – Inbound e Outbound
callerIDs Mostra somente quando Outbound e este callerID precisa ser enviado com a solicitação sendPhoneSurvey.Se você precisa adicionar outro CallerID entre em contato com a Equipe de Suporte para autorizá-lo.
phoneNumbers Mostra somente quando Inbound e mostra qual número de telefone seu questionário telefônico pode ser acessado e qual callerID você precisa ter para que ele responda.
completedAnswers Quantidade de respostas na pesquisa (para toda a pesquisa).
stoppedAnswers Quantidade de respostas bloqueadas na pesquisa (Para toda a pesquisa).
surveyLanguage O código curto do idioma usado na pesquisa telefônica.

sendPhoneSurvey

Sem pré-visualização

Faça a solicitação de discagem real.

A funcionalidade só funciona se você tiver o Phone Survey habilitado em sua conta!

Entre em contato com o departamento de vendas para habilitar.

Informações de dados POST:

(Vermelho informação é obrigatória), todas as legendas de dados POST são sensíveis a maiúsculas e minúsculas.

surveyID Id da pesquisa no Examinare.
user_ * contactID das informações de contato. * precisa ser alterado para números, por exemplo user_1, user_2 etc.
callerID Os callerids ativados em sua conta. Estes podem ser encontrados em calling listPhoneSurveys. (OPCIONAL)
Este site está registrado em wpml.org como um site de desenvolvimento. Mude para uma chave de site de produção para remove this banner.