Visão geral dos itens on ~.UcClient.~ Unified Communications

Obter Item

Mon, 01 Jan 0001 00:00:00 +0000

Obter Item #

Obtém um item de diretório específico.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Exemplo #

Esta solicitação obterá um item específico de um diretório nos seu id.

Solicitar #

GET <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Autorização: Portador {TOKEN}

Resposta #

HTTP/1.1 200 OK
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
{
	"page_size": 1,
	"dados": [ {
            "ID": "00000000-0000-0000-0000-000000000123",
            "campos": {
                "título": "Mr",
                "Nome completo": "CRM2",
                "CompanyName": "Empresa",
                "jobTitle": "Cargo",
                "telefone1": "+44XXXXXXXXXX",
                "email": "Endereço de e-mail",
                "campo1": "campo1",
                "campo2": "campo2",
                "crmId": "00000000-0000-0000-0000-000000000001"
            }
        }
    ][{
            "id": "00000000-0000-0000-0000-000000000123",
            "fields": {
                "title": "Mr",
                "fullName": "CRM2",
                "companyName": "Company",
                "jobTitle": "Job Title",
                "phone1": "+44XXXXXXXXXX",
                "email": "Email Address",
                "field1": "field1",
                "field2": "field2",
                "crmId": "00000000-0000-0000-0000-000000000001"
            }
        }
    ],
	"status": "sucesso",
	"carimbo de data/hora": "2019-01-01T10:00:00.2890319Z"
}

Erros #

Não autorizado #

Quando o token não é fornecido, inválido ou expirado

HTTP/1.1 401 Não autorizado

Obter itens

Mon, 01 Jan 0001 00:00:00 +0000

Obter itens #

Obtém todos os itens de diretório correspondentes ao filtro fornecido.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items?filter={FILTER}& campos={CAMPOS}

warning
Lembre-se de URL Codifique todos os parâmetros que estão sendo passados no » filtrar' parâmetro.

note
Ao pesquisar em » telefoneX' campos, os números são armazenados em E.164 formato.

Exemplo #

Este pedido irá consultar todos os itens com um campo telefónico contendo +44XXXXXXXXXX

Criar item

Mon, 01 Jan 0001 00:00:00 +0000

Criar item #

Cria um novo item de diretório no diretório fornecido.

POST /v1.0/contactdirectories/{DIRECTORY_ID}/items

Exemplo #

Essa solicitação criará um novo item de diretório.

Solicitar #

POST <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> HTTP/1.1
Tipo de conteúdo: application/json
Aceitação-Encargos: Verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
{
	"campos": {
        "título": "Mr",
        "Nome completo": "CRM3a",
        "CompanyName": "Empresa",
        "jobTitle": "Cargo",
        "telefone1": "+44XXXXXXXXXX",
        "email": "Endereço de e-mail",
        "campo1": "campo1",
        "campo2": "campo2",
        "crmId": "00000000-0000-0000-0000-000000000001"
    }
}

Resposta #

HTTP/1.1 201 Criado
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
Localização: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items>
{
	"dados": {
        "ID": "00000000-0000-0000-0000-000000000123",
        "campos": {
            "título": "Mr",
            "Nome completo": "CRM3a",
            "CompanyName": "Empresa",
            "jobTitle": "Cargo",
            "telefone1": "+44XXXXXXXXXX",
            "email": "Endereço de e-mail",
            "campo1": "campo1",
            "campo2": "campo2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "sucesso",
	"carimbo de data/hora": "2019-11-29T16:03:23.9251680Z"
}

Erros #

Não autorizado #

Quando o token não é fornecido, inválido ou expirado

HTTP/1.1 401 Não autorizado

Substituir item

Mon, 01 Jan 0001 00:00:00 +0000

Substituir item #

Substitui e item de diretório existente.

PUT /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Exemplo #

Essa solicitação atualizará um item de diretório existente.

Solicitar #

PUT <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Tipo de conteúdo: application/json
Aceitação-Encargos: Verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
{
    "campos": {
        "título": "Mr",
        "Nome completo": "CRM3a",
        "CompanyName": "Empresa",
        "jobTitle": "Cargo",
        "telefone1": "+44XXXXXXXXXX",
        "email": "Endereço de e-mail",
        "campo1": "campo1",
        "campo2": "campo2",
        "crmId": "00000000-0000-0000-0000-000000000001"
    }
}

Resposta #

HTTP/1.1 201 Criado
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
Localização: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123>
{
	"dados": {
        "ID": "00000000-0000-0000-0000-000000000123",
        "campos": {
            "título": "Mr",
            "Nome completo": "CRM3a",
            "CompanyName": "Empresa",
            "jobTitle": "Cargo",
            "telefone1": "+44XXXXXXXXXX",
            "email": "Endereço de e-mail",
            "campo1": "campo1",
            "campo2": "campo2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "sucesso",
	"carimbo de data/hora": "2019-11-29T16:03:23.9251680Z"
}

Erros #

Não autorizado #

Quando o token não é fornecido, inválido ou expirado

HTTP/1.1 401 Não autorizado

Patch Item

Mon, 01 Jan 0001 00:00:00 +0000

Patch Item #

Atualiza um conjunto específico de propriedades de um item de diretório. Isso usa o JSON Formato de patch para quaisquer alterações.

PATCH /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Exemplo #

Essa solicitação adicionará um novo campo de telefone a um item de diretório existente.

Solicitar #

PATCH <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Tipo de conteúdo: application/json
Aceitação-Encargos: Verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
{
    "caminho": "/fields/phone2",
    "op": "adicionar",
    "valor": "+44YYYYYYYYY"
}

Resposta #

HTTP/1.1 201 Criado
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
Localização: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123>
{
	"dados": {
        "ID": "00000000-0000-0000-0000-000000000123",
        "campos": {
            "título": "Mr",
            "Nome completo": "CRM3a",
            "CompanyName": "Empresa",
            "jobTitle": "Cargo",
            "telefone1": "+44XXXXXXXXXX",
            "phone2": "+44YYYYYYYYY",
            "email": "Endereço de e-mail",
            "campo1": "campo1",
            "campo2": "campo2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "sucesso",
	"carimbo de data/hora": "2019-11-29T16:03:23.9251680Z"
}

Erros #

Não autorizado #

Quando o token não é fornecido, inválido ou expirado

HTTP/1.1 401 Não autorizado

Excluir item

Mon, 01 Jan 0001 00:00:00 +0000

Excluir item #

Exclui um item existente de um diretório.

Solicitar #

DELETE /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Exemplo #

Esta solicitação excluirá o item específico dentro do diretório.

Solicitar #

DELETE <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Autorização: Portador {TOKEN}

Resposta #

HTTP/1.1 200 OK
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
{ 
	"dados": {
        "ID": "00000000-0000-0000-0000-000000000123",
        "campos": {
            "título": "Mr",
            "Nome completo": "CRM3a",
            "CompanyName": "Empresa",
            "jobTitle": "Cargo",
            "telefone1": "+44XXXXXXXXXX",
            "email": "Endereço de e-mail",
            "campo1": "campo1",
            "campo2": "campo2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "sucesso",
	"carimbo de data/hora": "2019-01-01T10:00:00.2890319Z"
}

Erros #

Não autorizado #

Quando o token não é fornecido, inválido ou expirado

HTTP/1.1 401 Não autorizado