> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.icommkt.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).
# Geração e remessas de peças guia WDSL
Este módulo inclui todos os serviços necessários para a criação de Peças e/ou Embarques.
# Criar Parte
Permite gerar uma nova Newsletter (Parte) no sistema.
### Petição
###### URL:
| http://dominioplataforma.icommarketing.com/Newsletters.asmx?WSDL
*platformdomain deve ser substituído pelo URL da instância
###### Serviço de internet:
| CriarHTML
### Parâmetros de Solicitação
| - **ApiKey**: Chave correspondente à instância (Obtenha no módulo de configuração da instância)
| - **UserName**: Nome do usuário de acesso à plataforma
| - **Campanha**: Nome da campanha na qual gerar a peça
| - **NewsletterName**: Nome da peça a gerar
| - **PlainText**: Texto simples da peça
| - **Conteúdo**: conteúdo HTML da peça
###### Solicitar Resposta -> Resultados
**Objeto com a seguinte estrutura (JSON) ->**
||| * StatusCode: Código do resultado da operação
||| * Mensagem: Texto do resultado da operação
||| * MessageDetail: Detalhes da mensagem de erro quando ela ocorre
||| * Dados: Informações adicionais
### Lista de Códigos de Resposta
||| **(1) Newsletter Criada**: A Newsletter foi criada e aprovada satisfatoriamente.
||| **(501) Modelo não encontrado**: O modelo HTML não foi encontrado na instância.
||| **(502) User Not Found**: O UserName enviado não foi encontrado entre os usuários da instância.
||| **(503) Campanha não encontrada**: A campanha enviada não existe.
||| **(504) A campanha não é válida para este usuário**: O usuário enviado não tem acesso à campanha solicitada.
||| **(505) Conteúdo ou texto sem formatação estão vazios**: O conteúdo ou texto sem formatação da solicitação está vazio.
||| **(550) General Error**: Ocorreu um erro ao gerar a peça, veja os campos Message e MessageDetail para mais informações.
||| **(512) Valor do campo SocialNetworks inválido: o conteúdo do campo SocialNetworks é inválido. Você deve enviar uma string delimitada por vírgulas que contenha os IDs das redes sociais que deseja incluir na comunicação.
### Exemplo de PHP
```php
require_once('lib/nusoap.php');
date_default_timezone_set('UTC');
$proxyhost = isset($_POST['proxyhost']) ? $_POST['proxyhost'] : '';
$proxyport = isset($_POST['proxyport']) ? $_POST['proxyport'] : '';
$proxyusername = isset($_POST['proxyusername']) ? $_POST['proxyusername'] : '';
$proxypassword = isset($_POST['proxypassword']) ? $_POST['proxypassword'] : '';
$useCURL = isset($_POST['usecurl']) ? $_POST['usecurl'] : '0';
$client = new nusoap_client('http://domain.icommarketing.com/Newsletters.asmx?WSDL','wsdl','','','','');
$err = $client->getError();
if ($err) {
echo 'Constructor error
' . $err . '
';
exit();
}
$client->setUseCurl($useCURL);
$html = 'HTML';
$html = utf8_decode($html);
$param = Array(
"ApiKey"=>"API_KEY",
"UserName"=>"UserName",
"Campaign"=>"Campaign Name",
"NewsletterName"=>"Newsletter Name",
"Content"=>$html,
"PlainText"=>"test"
);
$result = $client->call('CreateHTML',$param,",",false,true);
// Check for a fault
if ($client->fault) {
echo 'Fault
';
print_r($result);
echo '
';
} else {
// Check for errors
$err = $client->getError();
if ($err) {
// Display the error
echo 'Error
' . $err . '
';
} else {
echo 'Result
';
$auxresponse = json_decode($client->responseData);
echo 'StatusCode' . $auxresponse->{'StatusCode'} . '';
echo 'Message' . $auxresponse->{'Message'} . '';
echo 'MessageDetail' . $auxresponse->{'MessageDetail'} . '';
echo 'Data' . $auxresponse->{'Data'} . ''; }
}```
# Criar Remessa
Permite acionar uma nova entrega a partir da instância, detalhando o conteúdo a ser enviado e o público ao qual será endereçado.
### Petição
###### URL
| http://dominioplataforma.icommarketing.com/Deliveries.asmx?WSDL
*platformdomain deve ser substituído pelo URL da instância
###### Serviço de internet
| CriarConfiguração
### Parâmetros de Solicitação
| - **ApiKey**: Chave correspondente à instância (Obtenha no módulo de configuração da instância)
| - **UserName**: Nome do usuário de acesso à plataforma
| - **Campanha**: Nome da campanha na qual gerar a peça
| - **NewsletterName**: Nome da peça a gerar
| - **PlainText**: Texto simples da peça
| - **Conteúdo**: conteúdo HTML da peça
| - **FromMail**: Endereço de e-mail do remetente (deve existir na lista de endereços da plataforma)
| - **FromName**: Nome do remetente
| - **ReplyMail**: Endereço de Email de Resposta (deve existir na lista de endereços da plataforma)
| - **Assunto**: Assunto do e-mail
| - **Pré-cabeçalho**: Pré-cabeçalho do e-mail (informações adicionais ao Assunto que alguns programas de e-mail permitem)
| - **Perfis**: lista separada por vírgulas dos PROFILE_KEYs a serem associados ao embarque (obtenha os PROFILE_KEYs na tela PROFILES da plataforma).
| - **StartDate**: Data e Hora do Agendamento do Embarque. O formato deve ser AAAA-MM-DDTHH24:MI:SS.
| - **ViralMarketing**: Propriedade para determinar se você deseja incluir o LINK para que o destinatário possa encaminhar a Newsletter para um amigo. Valores possíveis: verdadeiro ou falso.
| - **Redes Sociais**: Propriedade para determinar QUAIS LINKS serão incluídos para compartilhar nas redes sociais. Este campo deve ser uma string de IDs separados por vírgulas, conforme a seguinte referência:
| * Identificação 1: Facebook
| * Identificação 2: Twitter
| * ID 3: LinkedIN
| * ID 4: Google+
| * ID 5: Pinterest
| **Nota**: Caso não deseje incorporar nenhum ícone para compartilhar nas redes sociais, este campo deve ficar VAZIO.
| - **Teste**: Propriedade para determinar se a remessa é de Teste ou Real. Valores possíveis: verdadeiro ou falso.
| - **SendGoogleAnalyticsData**: Propriedade para determinar se o envio inclui automaticamente os parâmetros de identificação da campanha para o Google Analytics. Valores possíveis: verdadeiro ou falso.
###### Solicitar Resposta -> Resultados
**Objeto com a seguinte estrutura (JSON) ->**
||| **StatusCode**: Código do resultado da operação
||| **Mensagem**: Texto do resultado da operação
||| **MessageDetail**: Detalhes da mensagem de erro quando ela ocorre
||| **Dados**: informações adicionais
### Lista de Códigos de Resposta
||| **(1) Configuração criada**: A configuração de envio foi criada e aprovada com sucesso.
||| **(501) Modelo não encontrado**: O modelo HTML não foi encontrado na instância.
||| **(502) User Not Found**: O UserName enviado não foi encontrado entre os usuários da instância.
||| **(503) Campanha não encontrada**: A campanha enviada não existe.
||| **(504) A campanha não é válida para este usuário**: O usuário enviado não tem acesso à campanha solicitada.
||| **(510) Profile(s) Not Found**: Qualquer um dos PROFILE_KEYs enviados não existe.
||| **(511) Perfil(es) selecionado(s) incompatível(is) com o modelo selecionado**: Os perfis enviados não são compatíveis com a parte enviada. A remessa será abortada.
||| **(550) General Error**: Ocorreu um erro ao gerar a peça, veja os campos Message e MessageDetail para mais informações.
### Exemplo de PHP
```php
require_once('lib/nusoap.php');
date_default_timezone_set('UTC');
$proxyhost = isset($_POST['proxyhost']) ? $_POST['proxyhost'] : '';
$proxyport = isset($_POST['proxyport']) ? $_POST['proxyport'] : '';
$proxyusername = isset($_POST['proxyusername']) ? $_POST['proxyusername'] : '';
$proxypassword = isset($_POST['proxypassword']) ? $_POST['proxypassword'] : '';
$useCURL = isset($_POST['usecurl']) ? $_POST['usecurl'] : '0';
$client = new nusoap_client('http://domain.icommarketing.com/Deliveries.asmx?WSDL','wsdl','','','','');
$err = $client->getError();
if ($err) {
echo 'Constructor error
' . $err . '
';
exit();
}
$client->setUseCurl($useCURL);
$html = 'HTML';
$html = utf8_decode($html);
$param = Array(
"ApiKey"=>"API_KEY",
"UserName"=>"UserName",
"Campaign"=>"Campaign Name",
"NewsletterName"=>"Newsletter Name",
"Content"=>$html,
"PlainText"=>"test",
"FromMail"=>"newsletter@dominionews.com",
"FromName"=>"FromName",
"Subject"=>"Subject",
"ReplyMail"=>" newsletter-reply@dominionews.com ",
"Profiles"=>"PROFILE_KEY1, PROFILE_KEY1",
"StartDate"=>"2014-06-06T17:30:00.000",
"ViralMarketing"=>"true",
"SocialNetworks"=>"1,2,3,4,5",
"Testing"=>"false",
"PreHeader"=>"PreHeader",
"SendGoogleAnalyticsData"=>"true"
);
$result = $client->call('CreateConfiguration',$param,",",false,true);
// Check for a fault
if ($client->fault) {
echo 'Fault
';
print_r($result);
echo '
';
} else {
// Check for errors
$err = $client->getError();
if ($err) {
// Display the error
echo 'Error
' . $err . '
';
} else {
echo 'Result
';
$auxresponse = json_decode($client->responseData);
echo 'StatusCode' . $auxresponse->{'StatusCode'} . '';
echo 'Message' . $auxresponse->{'Message'} . '';
echo 'MessageDetail' . $auxresponse->{'MessageDetail'} . '';
echo 'Data' . $auxresponse->{'Data'} . ''; }
}```
# Criar envio com notícias pré-existentes
Permite acionar uma nova remessa a partir da instância, utilizando uma peça criada anteriormente.
### Petição
###### URL
| http://dominioplataforma.icommarketing.com/Deliveries.asmx?WSDL
*platformdomain deve ser substituído pelo URL da instância
###### Serviço de internet
| CreateConfigurationWithExistingNews
### Parâmetros de Solicitação
| - **ApiKey**: Chave correspondente à instância (Obtenha no módulo de configuração da instância)
| - **UserName**: Nome do usuário de acesso à plataforma
| - **Campanha**: Nome da campanha na qual gerar a peça
| - **NewsletterName**: Nome da peça a gerar
| - **FromMail**: Endereço de e-mail do remetente (deve existir na lista de endereços da plataforma)
| - **FromName**: Nome do remetente
| - **ReplyMail**: Endereço de Email de Resposta (deve existir na lista de endereços da plataforma)
| - **Subject**: Assunto do e-mail
| - **PreHeader**: Pré-cabeçalho do e-mail (informações adicionais ao Assunto que alguns programas de e-mail permitem)
| - **Profiles**: lista separada por vírgulas dos PROFILE_KEYs a serem associados ao embarque (obtenha os PROFILE_KEYs na tela PROFILES da plataforma).
| - **StartDate**: Data e Hora do Agendamento do Embarque. O formato deve ser AAAA-MM-DDTHH24:MI:SS.
| - **ViralMarketing**: Propriedade para determinar se você deseja incluir o LINK para que o destinatário possa encaminhar a Newsletter para um amigo. Valores possíveis: verdadeiro ou falso.
| - **SocialNetworks**: Propriedade para determinar QUAIS LINKS serão incluídos para compartilhar nas redes sociais. Este campo deve ser uma sequência de IDs separados
| por vírgulas, conforme a seguinte referência:
| * ID 1: Facebook
| * ID 2: Twitter
| * ID 3: LinkedIN
| * ID 4: Google +
| * ID 5: Pinterest
| - **Nota**: Caso não deseje incorporar nenhum ícone para compartilhar nas redes sociais, este campo deve ficar VAZIO.
| - **Teste**: Propriedade para determinar se a remessa é de Teste ou Real. Valores possíveis: verdadeiro ou falso.
| - **SendGoogleAnalyticsData**: Propriedade para determinar se o envio inclui automaticamente os parâmetros de identificação da campanha para o Google
| Análise. Valores possíveis: verdadeiro ou falso.
###### Solicitar Resposta -> Resultados
**Objeto com a seguinte estrutura (JSON) ->**
||| **StatusCode**: Código do resultado da operação
||| **Mensagem**: Texto do resultado da operação
||| **MessageDetail**: Detalhes da mensagem de erro quando ela ocorre
||| **Dados**: informações adicionais
### Lista de códigos de resposta
||| **(1) Configuração criada**: A configuração de envio foi criada e aprovada com sucesso.
||| **(502) User Not Found**: O UserName enviado não foi encontrado entre os usuários da instância.
||| **(503) Campanha não encontrada**: A campanha enviada não existe.
||| **(504) A campanha não é válida para este usuário**: O usuário enviado não tem acesso à campanha solicitada.
||| **(505) NewsletterName não foi encontrado**: A newsletter solicitada para associar à entrega não foi encontrada.
||| **(510) Profile(s) Not Found**: Qualquer um dos PROFILE_KEYs enviados não existe.
||| **(550) General Error**: Ocorreu um erro ao gerar a peça, veja os campos Message e MessageDetail para mais informações.
### Exemplo de PHP
```php
require_once('lib/nusoap.php');
date_default_timezone_set('UTC');
$proxyhost = isset($_POST['proxyhost']) ? $_POST['proxyhost'] : '';
$proxyport = isset($_POST['proxyport']) ? $_POST['proxyport'] : '';
$proxyusername = isset($_POST['proxyusername']) ? $_POST['proxyusername'] : '';
$proxypassword = isset($_POST['proxypassword']) ? $_POST['proxypassword'] : '';
$useCURL = isset($_POST['usecurl']) ? $_POST['usecurl'] : '0';
$client = new nusoap_client('http://domain.icommarketing.com/Deliveries.asmx?WSDL','wsdl','','','','');
$err = $client->getError();
if ($err) {
echo 'Constructor error
' . $err . '
';
exit();
}
$client->setUseCurl($useCURL);
$html = 'HTML';
$html = utf8_decode($html);
$param = Array(
"ApiKey"=>"API_KEY",
"UserName"=>"UserName",
"Campaign"=>"Campaign Name",
"NewsletterName"=>"Newsletter Name",
"FromMail"=>"newsletter@dominionews.com",
"FromName"=>"FromName",
"Subject"=>"Subject",
"ReplyMail"=>" newsletter-reply@dominionews.com ",
"Profiles"=>"PROFILE_KEY1, PROFILE_KEY1",
"StartDate"=>"2014-06-06T17:30:00.000",
"ViralMarketing"=>"true",
"SocialNetworks"=>"1,2,3,4,5",
"Testing"=>"false",
"PreHeader"=>"PreHeader",
"SendGoogleAnalyticsData"=>"true"
);
$result = $client->call('CreateConfigurationWithExistingNews',$param,",",false,true);
// Check for a fault
if ($client->fault) {
echo 'Fault
';
print_r($result);
echo '
';
} else {
// Check for errors
$err = $client->getError();
if ($err) {
// Display the error
echo 'Error
' . $err . '
';
} else {
echo 'Result
';
$auxresponse = json_decode($client->responseData);
echo 'StatusCode' . $auxresponse->{'StatusCode'} . '';
echo 'Message' . $auxresponse->{'Message'} . '';
echo 'MessageDetail' . $auxresponse->{'MessageDetail'} . '';
echo 'Data' . $auxresponse->{'Data'} . ''; }
}```