callRecord: getSmsLog
Namespace: microsoft.graph.callRecords
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Obtenha o log de um SMS enviado/recebido como uma coleção de entradas smsLogRow .
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | Sem suporte. | Sem suporte. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | CallRecords.Read.All | Indisponível. |
Solicitação HTTP
GET /communications/callRecords/getSmsLog(fromDateTime={fromDateTime},toDateTime={toDateTime})
Parâmetros de função
Na URL da solicitação, forneça os seguintes parâmetros de consulta com valores.
Parâmetro | Tipo | Descrição |
---|---|---|
fromDateTime | DateTimeOffset | Início do intervalo de tempo para consultar. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z . Obrigatório. |
Todatetime | DateTimeOffset | Intervalo de tempo final para consulta. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z . Obrigatório. |
Importante
Os valores fromDateTime e toDateTime não podem ser mais do que um intervalo de datas de 90 dias.
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedida, essa função retornará um 200 OK
código de resposta e uma coleção de entradas microsoft.graph.callRecords.smsLogRow no corpo da resposta.
Se a função retornar mais de 1.000 entradas para o intervalo de datas especificado, o corpo também inclui um @odata.nextLink
com uma URL para consultar a próxima página de entradas. A última página no intervalo de datas não tem um @odata.nextLink
. Para obter mais informações, confira paginar dados do Microsoft Graph em seu aplicativo.
Exemplo
O exemplo a seguir mostra como obter o log de SMS enviado/recebido que ocorreu no intervalo de datas especificado. A resposta inclui "@odata.count": 1000
enumerar o número de registros nesta primeira resposta e um @odata.nextLink
para obter registros além dos primeiros 1.000. Para legibilidade, o objeto de resposta contém apenas uma coleção de um registro.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/communications/callRecords/getSmsLog(fromDateTime=2022-11-01,toDateTime=2022-12-01)
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.callRecords.smsLogRow)",
"@odata.count": 1000,
"@odata.nextLink": "https://graph.microsoft.com/beta/communications/callRecords/getSmsLog(fromDateTime=2022-11-01,toDateTime=2022-12-01)?$skip=1000",
"value": [
{
"smsId": "ef36b3e8-9922-4763-90e2-f4345c04a5d6",
"userId": "19b900af-fe99-48d6-a9a4-b79c995afc33",
"userPrincipalName": "ruwini.perera@contoso.com",
"userDisplayName": "Ruwini Perera",
"userCountryCode": "US",
"tenantCountryCode": "US",
"sourceNumber": "+12818602122",
"destinationNumber": "+12673173004",
"sentDateTime": "2022-10-06T11:15:48.6113555Z",
"callCharge": 0.00,
"currency": "USD",
"smsType": "sms_in",
"destinationContext": "Domestic",
"destinationName": "United States",
"otherPartyCountryCode": "US",
"licenseCapability": "MCOSMS1",
"smsUnits": 1,
"administrativeUnitInfos": [
{
"id": "639b616c-f164-4a6f-a933-24936b8eb210"
},
{
"id": "cc6ea167-4e92-4c2d-9391-85791e978006"
}
]
}
]
}