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 Twitter.
Documentação de Uso da API de Social Media - Twitter.
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 Twitter para que você possa autenticar com a conta desejada.
Após autenticar com a conta do Twitter, e autorizar o uso do aplicativo você receberá o seu token de acesso.
Após autenticar com a conta do Twitter, 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 Twitter. | Json | |
| SendMessage | object | Objeto de estruturação do envio de mensagens. | Json | |
| User_id | string | Id do Twitter 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 | |
| Extension | string | extensão da imagem, que pode ser jpeg, jpg, png ou gif (quando houver). | Json |
Exemplo de JSON em troca de mensagens no Twitter, substitua as informações abaixo de token pelo token obtido no Login.
{
"SocialMedia": 0,
"Id": "TesteTwitter",
"Token": "000000",
"Type": "Twitter",
"SendMessage":
{
"User_id": "1231513110",
"Message": "Tive uma boa refeição hoje.",
"Media": "http://urlquevcquiser.com",
"Extension": "jpg"
}
}
Aqui o resultado, em imagem para seu contato:
Pelo Social Media da Mensageria Flex, é possível fazer um tweet 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 Twitter. | 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 | |
| Extension | string | Extensão da imagem, que pode ser jpeg, jpg, png ou gif (quando houver). | Json |
Exemplo de JSON pra tweet no Twitter, substitua as informações abaixo de token pelo token obtido no Login.
{
"SocialMedia": 0,
"Id": "TesteTwitter",
"Token": "000000",
"Type": "Twitter",
"PostMessage":
{
"Message": "Texto para Teste",
"Media": "https://site.com.br/imagem.jpg",
"Extension": "jpg"
}
}
Aqui o resultado, em imagem para seu contato:
Pelo Social Media da Mensageria Flex, é possível fazer uma resposta do comentario no tweet 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 Twitter. | 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_tweet_id | string | Id do Tweet na qual voce esta realzando a resposta (Id enviado via webhook). | Json | |
| screenName_reply | string | Nome da conta para quem voces esta fazendo o comentario.(screenName sender enviado via webhook). | Json |
Exemplo de JSON pra reply tweet no Twitter, substitua as informações abaixo de token pelo token obtido no Login.
{
"SocialMedia": 0,
"Id": "TesteTwitter",
"Token": "000000",
"Type": "Twitter",
"PostMessage":
{
"Message": "Texto para Teste",
"in_reply_to_tweet_id": "1214141",
"screenName_reply": "jorge2019"
}
}
Pelo Social Media da Mensageria Flex, é possível listar os contatos do Twitter da conta autenticada.
Método utilizado para listar contatos.
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 Twitter. | Json | |
| GetFriends | object | Objeto de estruturação de informação de contatos. | Json | |
| getID | boolean | Se false, exibirá os detalhes do contato como id do usuário, nome, screenname, foto de perfil (é limitado pelo Twitter em 229 contatos na lista). Se true, exibe apenas o id do usuário, e é limitado pelo Twitter em 4499 contatos na lista. | Json | |
| size | int | É a quantidade de contatos listados. | Json |
Exemplo de JSON pra listar contatos no Twitter, substitua as informações abaixo de token pelo token obtido no Login.
{
"SocialMedia": 1,
"Id": "TesteViaTwiiter",
"Token": "c91b638f75",
"Type": "Twitter",
"GetFriends":
{
"getID": false,
"size": 229
}
}
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. 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 Twitter. |
| typeEvent | string | Tipo de evento. |
| idAccount | string | ID de quem esta registrado o webhook. |
| User_id | string | ID da conta que recebeu a mensagem. |
| Message | string | Mensagem enviada. |
| 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": "Twitter",
"typeEvent": "direct_message",
"idAccount": "1234145",
"User_id": "1231451",
"message": "Olá tudo bem?",
"sender":
{
"id": "12345678",
"name": "maisa",
"screenName": "maisaOficial"
},
"recipient":
{
"id": "123456656543",
"name": "andaramis",
"screenName": "andamastorOficial"
}
}
Quando o usuário realiza um comentário em uma postagem para a conta inscrita, este evento é considerado um Tweet 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 Twitter. |
| typeEvent | string | Tipo de evento. |
| idAccount | string | ID de quem esta registrado o webhook. |
| User_id | string | ID da conta que recebeu a mensagem. |
| Message | string | Mensagem enviada. |
| tweet | object | Informações sobre o Post Original na qual o usuário fez o comentário. |
| 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": "Twitter",
"typeEvent": "tweet_events",
"idAccount": "1234145",
"User_id": "1231451",
"message": "como faço para me candidatar?",
"tweet":
{
"in_reply_to_tweet_id": "1214141",
"message": "hoje temos vagas para analista!"
},
"sender":
{
"id": "12345678",
"name": "jorge",
"screenName": "jorge2019"
},
"recipient":
{
"id": "123456656543",
"name": "andaramis",
"screenName": "andamastorOficial"
}
}
Envios de mensagens, postagens e receber amigos.
Envios de mensagens e postagens em redes sociais como o Twitter.
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
}