{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/accounts/:account_id/sms","auth":"required","params":[{"name":"account_id","type":"int","default":"","desc":"Account ID","required":false,"in":"path","ref":"","_id":"56fae76b4787442b008db3c0"},{"name":"filters[id]","type":"array_string","default":"","desc":"ID filter","required":false,"in":"query","ref":"","_id":"573a3fdb17422532001d3451"},{"name":"filters[from]","type":"string","default":"","desc":"Caller ID filter, the E.164 phone number to send the SMS FROM. Note: you must encode the + as %2B, and the direction filter is required.","required":false,"in":"query","ref":"","_id":"58054bd716161c0f0077e0b3"},{"name":"filters[to]","type":"string","default":"","desc":"Callee ID filter, the E.164 phone number to send the SMS TO. Note you must encode the + as %2B, and the direction filter is required.","required":false,"in":"query","ref":"","_id":"588b3ab1ed9aa81b00afbdac"},{"name":"filters[direction]","type":"string","default":"","desc":"Direction filter, in or out","required":false,"in":"query","ref":"","_id":"573a3fdb17422532001d3450"},{"name":"filters[extension]","type":"string","default":"","desc":"Extension id where SMS is stored","required":false,"in":"query","ref":"","_id":"588b3bd5b39ea10f0047a985"},{"name":"filters[created_at]","type":"int","default":"","desc":"Date string representing the UTC time that sms was created","required":false,"in":"query","ref":"","_id":"588b3bd5b39ea10f0047a984"},{"name":"filters[deleted]","type":"string","default":"","desc":"only=deleted SMS; ignore=existing SMS; with=both deleted and existing SMS","required":false,"in":"query","ref":"","_id":"5a04ad0f9413ff001cedda6b"},{"name":"sort[id]","type":"string","default":"","desc":"Sort by ID","required":false,"in":"query","ref":"","_id":"573a3fdb17422532001d344f"},{"name":"sort[created_at]","type":"int","default":"","desc":"Sort by the UTC time that sms was created","required":false,"in":"query","ref":"","_id":"573a3fdb17422532001d344e"},{"name":"limit","type":"int","default":"","desc":"Max results","required":false,"in":"query","ref":"","_id":"573a43b07f35072900c8512d"},{"name":"offset","type":"int","default":"","desc":"Results to skip","required":false,"in":"query","ref":"","_id":"573a43b07f35072900c8512c"},{"name":"fields","type":"string","default":"all","desc":"Field set","required":false,"in":"query","ref":"","_id":"573c6c74ee2b3b2200422b70"}],"results":{"codes":[{"name":"","code":"{\n    \"filters\": {\n        \"from\": \"+17329910138\"\n    },\n    \"sort\": {\n        \"id\": \"asc\"\n    },\n    \"total\": 2,\n    \"offset\": 0,\n    \"limit\": 25,\n    \"items\": [\n        {\n            \"id\": \"08ae44ad-7408-11e4-9f47-cb5644081d04\",\n            \"from\": \"+17329910138\",\n            \"to\": [\n                {\n                    \"number\": \"+17327704200\",\n                    \"status\": \"received\"\n                }\n            ],\n            \"direction\": \"in\",\n            \"created_epoch\": 1476659032,\n            \"created_at\": \"2016-10-16T23:03:52+00:00\",\n            \"is_new\": false,\n            \"text\": \"What is the pricing for unlimited user?\",\n        },\n        {\n            \"id\": \"8f7a99b533655f9482bcfe25bb845a86d6c28344\",\n            \"from\": \"+17329910138\",\n            \"to\": [\n                {\n                    \"number\": \"+17326830492\",\n                    \"status\": \"sent\"\n                }\n            ],\n            \"direction\": \"out\",\n            \"created_epoch\": 1476659133,\n            \"created_at\": \"2016-10-16T23:05:33+00:00\",\n            \"is_new\": true,\n            \"text\": \"Testing outgoing message\",\n        },\n    ]\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"<?php\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n$response = $client->get('accounts/123/sms?filters[from]=%2B17329910138&sort[id]=asc');","language":"php"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"List SMS","type":"endpoint","slug":"list-account-sms","excerpt":"Get a list of SMS messages for an account.  See [Intro to SMS](doc:account-sms) for more info on the properties.\n\nNote: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List SMS API with the following definition:\n\nGET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms","body":"","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"580526e192398f0f00e7759a","__v":8,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Account SMS","slug":"account-sms","order":26,"from_sync":false,"reference":true,"_id":"5804d12d16161c0f0077df9b","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"createdAt":"2016-10-17T13:25:01.088Z"},"user":"56f99ab84d2b4f3400edb636","version":{"version":"4","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f","5ede526e75bc22005d0adecc"],"_id":"57624356653c2d2200fec79c","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","__v":23,"project":"55c8cff571d7580d0063a5e5"},"parentDoc":null,"project":"55c8cff571d7580d0063a5e5","githubsync":"","createdAt":"2016-10-17T19:30:41.200Z"}

getList SMS

Get a list of SMS messages for an account. See [Intro to SMS](doc:account-sms) for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List SMS API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID

Query Params

filters[id]:
array of strings
ID filter
filters[from]:
string
Caller ID filter, the E.164 phone number to send the SMS FROM. Note: you must encode the + as %2B, and the direction filter is required.
filters[to]:
string
Callee ID filter, the E.164 phone number to send the SMS TO. Note you must encode the + as %2B, and the direction filter is required.
filters[direction]:
string
Direction filter, in or out
filters[extension]:
string
Extension id where SMS is stored
filters[created_at]:
integer
Date string representing the UTC time that sms was created
filters[deleted]:
string
only=deleted SMS; ignore=existing SMS; with=both deleted and existing SMS
sort[id]:
string
Sort by ID
sort[created_at]:
integer
Sort by the UTC time that sms was created
limit:
integer
Max results
offset:
integer
Results to skip
fields:
stringall
Field set

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}