API ZaaS de comunicação para midias sociais.
Esta documentação tem como objetivo instruir sobre a utilização da mesma, demonstrando como realizar a comunicação no Facebook.
Documentação de Uso da API de Social Media - Facebook.
Para acessar o Social Media da Mensageria Flex, é necessário ter um usuário e senha pré-cadastrados.
A equipe de desenvolvimento da Mensageria Flex fará o cadastro e te retornará para que você possa acessar.
A equipe te retornará também o id Social Media pertencente a você. Após a criação do usuário, você deverá acessar o portal http://api.flexcontact.com.br/portalmedia, entrando com seu usuário e senha.
POST - https://api.flexcontact.com.br/portalmedia
Demonstrando como realizar o login no portal media.
Nesta tela, escolha a opção “Facebook” para que você possa autenticar com a conta desejada.
Após autenticar com a conta do Facebook, e autorizar o uso do aplicativo você receberá o seu token de acesso.
Após autenticar com a conta do Facebook, e autorizar o uso do aplicativo você receberá o seu token de acesso.
Pelo Social Media da Mensageria Flex, é possível fazer o envio de mensagens para seus contatos via api.
Método utilizado para enviar mensagem.
É importante lembrar que este processo é receptivo, ou seja, a conta que está em uso ficará esperando uma mensagem para que desta forma, possa fazer a interação com o outro lado. A regra para esta funcionalidade é que sempre haja algum tipo de interação antes de postar pela api.
POST - https://api.flexcontact.com.br/socialmedia/send
Os campos utilizados estão descritos abaixo:
| Campo | Tipo | Descrição | Parâmetro | Obrigatório |
|---|---|---|---|---|
| SocialMedia | string | Id que a equipe de Mensageria da Flex te mandou. | Json | |
| Id | string | Id alfanumérico de seu uso para que as mensagens possam ser rastreadas futuramente. | Json | |
| Token | string | Código alfanumérico que você recebeu no momento de autenticar no portal da Mensageria Flex. | Json | |
| Type | string | Aqui será sempre Facebook. | Json | |
| Page | string | ID identificador da Pagina. | Json | |
| SendMessage | object | Objeto de estruturação do envio de mensagens. | Json | |
| User_id | string | Id do Facebook do seu contato. | Json | |
| Message | string | Mensagem que você irá postar ao seu contato. | Json | |
| Media | string | Caminho da imagem que você está postando ao seu contato (quando houver). | Json |
Exemplo de JSON em troca de mensagens no Facebook, substitua as informações abaixo de token pelo token obtido no Login.
{
"SocialMedia": 2,
"Id": "TesteFacebook",
"Token": "000000",
"Type": "Facebook",
"Page": "FlexDev",
"SendMessage":
{
"User_id": "1231513110",
"Message": "Tive uma boa refeição hoje.",
"Media": "http://urlquevcquiser.com"
}
}
Pelo Social Media da Mensageria Flex, é possível fazer um post via api.
Método utilizado para fazer postagem.
POST - https://api.flexcontact.com.br/socialmedia/send
Os campos utilizados estão descritos abaixo:
| Campo | Tipo | Descrição | Parâmetro | Obrigatório |
|---|---|---|---|---|
| SocialMedia | string | Id que a equipe de Mensageria da Flex te mandou. | Json | |
| Id | string | Id alfanumérico de seu uso para que as mensagens possam ser rastreadas futuramente. | Json | |
| Token | string | Código alfanumérico que você recebeu no momento de autenticar no portal da Mensageria Flex. | Json | |
| Type | string | Aqui será sempre Facebook. | Json | |
| Page | string | ID identificador da Pagina. | Json | |
| PostMessage | object | Objeto de estruturação do envio de postagem. | Json | |
| Message | string | Mensagem que você irá postar ao seu contato. | Json | |
| Media | string | Caminho da imagem que você está postando ao seu contato (quando houver). | Json | |
| Link | string | Url de um Link para ser inserido na postagem (quando houver). | Json |
Exemplo de JSON pra feed no Facebook, substitua as informações abaixo de token pelo token obtido no Login.
{
"SocialMedia": 1,
"Id": "TesteFacebook1",
"Token": "000000",
"Type": "Facebook",
"Page": "12548721000145012",
"PostMessage":
{
"Message": "Texto para Teste",
"Media": "https://i.uai.com.br/lOUb1DkEdfEK_LMaUFvDsqFiaGg=/",
"Link": "https://api.flexcontact.com.br/PortalMedia"
}
}
Pelo Social Media da Mensageria Flex, é possível fazer uma resposta do comentario no facebook via api.
Método utilizado para fazer postagem.
POST - https://api.flexcontact.com.br/socialmedia/send
Os campos utilizados estão descritos abaixo:
| Campo | Tipo | Descrição | Parâmetro | Obrigatório |
|---|---|---|---|---|
| SocialMedia | string | Id que a equipe de Mensageria da Flex te mandou. | Json | |
| Id | string | Id alfanumérico de seu uso para que as mensagens possam ser rastreadas futuramente. | Json | |
| Token | string | Código alfanumérico que você recebeu no momento de autenticar no portal da Mensageria Flex. | Json | |
| Type | string | Aqui será sempre Facebook. | Json | |
| Page | string | ID identificador da Pagina (Nome da sua página). | Json | |
| PostMessage | object | Objeto de estruturação do envio de postagem. | Json | |
| Message | string | Mensagem que você irá postar ao seu contato. | Json | |
| in_reply_to_comment_id | string | Id do Comentário na qual voce esta realzando a resposta (Id enviado via webhook). | Json |
Exemplo de JSON pra resposta ao comentário no Facebook, substitua as informações abaixo de token pelo token obtido no Login.
{
"SocialMedia": 0,
"Id": "TesteFacebook",
"Token": "000000",
"Type": "Facebook",
"Page": "FlexDev",
"PostMessage":
{
"Message": "Texto para Teste",
"in_reply_to_comment_id": "1214141"
}
}
Pelo Social Media da Mensageria Flex, no metodo User, podemos listar o Token obtido no Login, lembrando que é necessario ter logado pelo Portal ao menos uma vez.
Método utilizado para listar o Token.
POST - https://api.flexcontact.com.br/socialmedia/user
Os campos utilizados estão descritos abaixo:
| Campo | Tipo | Descrição | Parâmetro | Obrigatório |
|---|---|---|---|---|
| User | string | Usuario de Login fo Portal. | Json | |
| Password | string | Senha de Login fo Portal. | Json |
Exemplo de JSON pra listar o Token.
{
"user": "usuario",
"password": "senha123"
}
Para identificar o retorno, é necessário criar um webhook em um endereço configurado, assim o mesmo irá enviar o retorno do evento quando um evento acontece através de um JSon.
Apos a criação do webhook, o mesmo deve ser informado a equipe de sistemas para configuração.
Após criar o hook e enviar sua URL de Webhook as funcionalidades de callback estão ativas.
Quando o usuário envia uma mensagem privada para a conta inscrita, este evento é considerado um Direct Message. Assim que a mensagem é enviada, o webhook irá informar instantaneamente para sua URL as informações da mesma.
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | Id alfanumérico de seu uso para que as mensagens possam ser rastreadas. |
| socialMedia | int | Id que a equipe de Mensageria da Flex te mandou. |
| Date | string | Data na qual o evento foi enviado. |
| Type | string | Tipo de ação, aqui será sempre Facebook. |
| typeEvent | string | Tipo de evento. |
| From | object | Informaçoes da Página. |
| Sender | object | Informações de quem mandou a mensagem |
| Recipient | object | Informações de quem recebeu a mensagem |
Exemplo do JSon enviado para este evento.
{
"id": "123",
"socialMedia": 1,
"date": "2019-07-16 16:55:26.970",
"type": "Facebook",
"typeEvent": "message",
"from":
{
"Page": "FlexDev",
"Page_id": "673948583053480"
},
"sender":
{
"sender_id": "12345678",
"name": "Jose Antonio",
"message": "Ola, teste",
"media": "http://url.com.br/teste.png"
},
"recipient":
{
"recipient_id": "123456656543"
}
}
Quando o usuário realiza um comentário em uma postagem para a conta inscrita, este evento é considerado um Post Events. Assim que a mensagem é enviada, o webhook irá informar instantaneamente para sua URL as informações da mesma. Exemplo real do JSON enviado para este evento.
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | Id alfanumérico de seu uso para que as mensagens possam ser rastreadas. |
| socialMedia | int | Id que a equipe de Mensageria da Flex te mandou. |
| Date | string | Data na qual o evento foi enviado. |
| Type | string | Tipo de ação, aqui será sempre Facebook. |
| typeEvent | string | Tipo de evento. |
| Message | string | Mensagem enviada. |
| link | string | Link enviado (opcional). |
| Post_id | string | ID da postagem. |
| Comment_id | string | ID do comentários. |
| Parent_id | string | ID pai do comentário. |
| Share_id | string | ID do Compartilhamento (Caso exista). |
| From | object | Informaçoes da Página. |
| Sender | object | Informações de quem mandou a mensagem. |
| Comment | object | Informações do comentário feito. |
Exemplo do JSon de comentário no Post de uma página do Facebook.
{
"id": "123",
"socialMedia": 1,
"date": "2019-07-16 16:55:26.970",
"type": "Facebook",
"typeEvent": "comment",
"message": "como faço para me candidatar?",
"link": "https://url",
"post_id": "1223458745",
"comment_id": "54878745",
"parent_id": "65477788",
"share_id": "44111111",
"from":
{
"Page": "FlexDev",
"Page_id": "1214141"
},
"sender":
{
"name": "Jose Antonio",
"sender_id": "12345678"
},
"comment":
[
{
"id": "123456656543",
"message": "Bom dia Asato."
}
]
}
Envios de mensagens, postagens e receber amigos.
Envios de mensagens e postagens em redes sociais como o Facebook.
POST - /Send
Usage and SDK Samples
curl -X POST "https://api.flexcontact.com.br/SocialMedia/Send"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SocialMediaApi;
import java.io.File;
import java.util.*;
public class SocialMediaApiExample {
public static void main(String[] args) {
SocialMediaApi apiInstance = new SocialMediaApi();
SocialMedia socialMedia = ; // SocialMedia | Objeto recebido para identificação da ação
try {
inline_response_200 result = apiInstance.sendPost(socialMedia);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SocialMediaApi#sendPost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.SocialMediaApi;
public class SocialMediaApiExample {
public static void main(String[] args) {
SocialMediaApi apiInstance = new SocialMediaApi();
SocialMedia socialMedia = ; // SocialMedia | Objeto recebido para identificação da ação
try {
inline_response_200 result = apiInstance.sendPost(socialMedia);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SocialMediaApi#sendPost");
e.printStackTrace();
}
}
}
SocialMedia *socialMedia = ; // Objeto recebido para identificação da ação (optional)
SocialMediaApi *apiInstance = [[SocialMediaApi alloc] init];
// Envios de mensagens, postagens e receber amigos
[apiInstance sendPostWith:socialMedia
completionHandler: ^(inline_response_200 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var SocialMedia = require('social_media');
var api = new SocialMedia.SocialMediaApi()
var opts = {
'socialMedia': // {SocialMedia} Objeto recebido para identificação da ação
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.sendPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class sendPostExample
{
public void main()
{
var apiInstance = new SocialMediaApi();
var socialMedia = new SocialMedia(); // SocialMedia | Objeto recebido para identificação da ação (optional)
try
{
// Envios de mensagens, postagens e receber amigos
inline_response_200 result = apiInstance.sendPost(socialMedia);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SocialMediaApi.sendPost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\SocialMediaApi();
$socialMedia = ; // SocialMedia | Objeto recebido para identificação da ação
try {
$result = $api_instance->sendPost($socialMedia);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SocialMediaApi->sendPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SocialMediaApi;
my $api_instance = WWW::SwaggerClient::SocialMediaApi->new();
my $socialMedia = WWW::SwaggerClient::Object::SocialMedia->new(); # SocialMedia | Objeto recebido para identificação da ação
eval {
my $result = $api_instance->sendPost(socialMedia => $socialMedia);
print Dumper($result);
};
if ($@) {
warn "Exception when calling SocialMediaApi->sendPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.SocialMediaApi()
socialMedia = # SocialMedia | Objeto recebido para identificação da ação (optional)
try:
# Envios de mensagens, postagens e receber amigos
api_response = api_instance.send_post(socialMedia=socialMedia)
pprint(api_response)
except ApiException as e:
print("Exception when calling SocialMediaApi->sendPost: %s\n" % e)
| Campo | Tipo |
|---|---|
| idMessage | string |
| status | string |
| message | string |
| friends | object |
Schema.
{
"idMessage": string,
"status": string,
"message": string,
"friends":
[
{
"id": string,
"name": string,
"screenName": string,
"status": string,
"url400x400": string
}
]
}
| Campo | Tipo |
|---|---|
| error | string |
Schema.
{
"error": string
}