{"_id":"5804d3a8d1b3990f00208992","githubsync":"","__v":1,"project":"55c8cff571d7580d0063a5e5","user":"56f99ab84d2b4f3400edb636","version":{"_id":"57624356653c2d2200fec79c","__v":21,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"5804d12d16161c0f0077df9b","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-17T13:25:01.088Z","from_sync":false,"order":26,"slug":"account-sms","title":"Account SMS"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-17T13:35:36.682Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level SMS API with the following definition:\\n\\nhttps://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms\"\n}\n[/block]\nPhone.com’s standard phone service lets you send and receive SMS messages using your Phone.com numbers. The Phone.com API extends this functionality, letting you send SMS messages from your application (through your phone number and our API server) to your users. You can also use the API to retrieve the history of sms sent from / delivered to your account. \n\n## Supported Services\n* [List SMS](doc:list-account-sms) \n* [Get SMS](doc:get-account-sms) \n* [Create SMS](doc:create-account-sms) \n* [Patch SMS](doc:patch-account-sms) \n* [Delete SMS](doc:delete-account-sms) \n\n## Summary Object\nThe SMS Summary Object is used to briefly represent a sms. It can be seen in several places throughout this API. Here are the properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Unique SMS ID. Read-only.\",\n    \"1-0\": \"`from`\",\n    \"1-1\": \"String (E.164 format)\\nExample: +15551112222\",\n    \"1-2\": \"Caller ID number to display on the incoming/outgoing SMS message.  For an outgoing message, it must be a phone number associated with your Phone.com account.\",\n    \"2-0\": \"`to`\",\n    \"2-1\": \"Array of [Recipient Object](#section-recipient-object)\",\n    \"3-0\": \"`direction`\",\n    \"3-1\": \"String\\n\\\"in\\\" or \\\"out\\\"\",\n    \"2-2\": \"An array of SMS recipients.\",\n    \"3-2\": \"Direction of SMS.  'in' for Incoming messages, 'out' for Outgoing messages.\",\n    \"4-0\": \"`text`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Body of the SMS text\",\n    \"5-0\": \"`created_epoch`\",\n    \"5-1\": \"Integer\",\n    \"5-2\": \"Unix time stamp representing the UTC time that the object was created in the Phone.com API system.\",\n    \"6-0\": \"`created_at`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Date string representing the UTC time that the object was created in the Phone.com API system.\",\n    \"7-0\": \"'is_new'\",\n    \"7-1\": \"Boolean\",\n    \"7-2\": \"True when SMS is new; False when SMS has been read.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\nHere's an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"53a58467-7023-11e4-b9e5-b7869fba3bc9\\\",\\n    \\\"from\\\": \\\"+17327704200\\\",\\n    \\\"to\\\": [\\n        {\\n            \\\"number\\\": \\\"+17329910138\\\",\\n            \\\"status\\\": \\\"sent\\\"\\n        }\\n    ],\\n    \\\"direction\\\": \\\"out\\\",\\n    \\\"created_epoch\\\": 1416425775,\\n    \\\"created_at\\\": \\\"2014-11-19T19:36:15+00:00\\\",\\n    \\\"is_new\\\": false,\\n    \\\"text\\\": \\\"This is an outbound SMS\\\",\\n    \\\"extension\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full SMS Object includes all of the properties in the [SMS Summary Object](#section-summary-object).\n\n## Recipient Object\nEach entry in a SMS's recipient list is an object with the following properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`number`\",\n    \"0-1\": \"Phone number that will receive the SMS message\",\n    \"1-0\": \"`status`\",\n    \"1-1\": \"Indicate the status of your SMS object.  May be 'sent', 'received', 'queued', 'new' ...\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nHere's an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"number\\\": \\\"+19142661483\\\",\\n    \\\"status\\\": \\\"received\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"The Phone.com /sms service lets you send and show history of SMS messages.","slug":"account-sms","type":"basic","title":"SMS"}

SMS

The Phone.com /sms service lets you send and show history of SMS messages.

[block:callout] { "type": "info", "body": "Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level SMS API with the following definition:\n\nhttps://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms" } [/block] Phone.com’s standard phone service lets you send and receive SMS messages using your Phone.com numbers. The Phone.com API extends this functionality, letting you send SMS messages from your application (through your phone number and our API server) to your users. You can also use the API to retrieve the history of sms sent from / delivered to your account. ## Supported Services * [List SMS](doc:list-account-sms) * [Get SMS](doc:get-account-sms) * [Create SMS](doc:create-account-sms) * [Patch SMS](doc:patch-account-sms) * [Delete SMS](doc:delete-account-sms) ## Summary Object The SMS Summary Object is used to briefly represent a sms. It can be seen in several places throughout this API. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "String", "0-2": "Unique SMS ID. Read-only.", "1-0": "`from`", "1-1": "String (E.164 format)\nExample: +15551112222", "1-2": "Caller ID number to display on the incoming/outgoing SMS message. For an outgoing message, it must be a phone number associated with your Phone.com account.", "2-0": "`to`", "2-1": "Array of [Recipient Object](#section-recipient-object)", "3-0": "`direction`", "3-1": "String\n\"in\" or \"out\"", "2-2": "An array of SMS recipients.", "3-2": "Direction of SMS. 'in' for Incoming messages, 'out' for Outgoing messages.", "4-0": "`text`", "4-1": "String", "4-2": "Body of the SMS text", "5-0": "`created_epoch`", "5-1": "Integer", "5-2": "Unix time stamp representing the UTC time that the object was created in the Phone.com API system.", "6-0": "`created_at`", "6-1": "String", "6-2": "Date string representing the UTC time that the object was created in the Phone.com API system.", "7-0": "'is_new'", "7-1": "Boolean", "7-2": "True when SMS is new; False when SMS has been read." }, "cols": 3, "rows": 8 } [/block] Here's an example: [block:code] { "codes": [ { "code": "{\n \"id\": \"53a58467-7023-11e4-b9e5-b7869fba3bc9\",\n \"from\": \"+17327704200\",\n \"to\": [\n {\n \"number\": \"+17329910138\",\n \"status\": \"sent\"\n }\n ],\n \"direction\": \"out\",\n \"created_epoch\": 1416425775,\n \"created_at\": \"2014-11-19T19:36:15+00:00\",\n \"is_new\": false,\n \"text\": \"This is an outbound SMS\",\n \"extension\": null\n}", "language": "json" } ] } [/block] ## Full Object The Full SMS Object includes all of the properties in the [SMS Summary Object](#section-summary-object). ## Recipient Object Each entry in a SMS's recipient list is an object with the following properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`number`", "0-1": "Phone number that will receive the SMS message", "1-0": "`status`", "1-1": "Indicate the status of your SMS object. May be 'sent', 'received', 'queued', 'new' ..." }, "cols": 2, "rows": 2 } [/block] Here's an example: [block:code] { "codes": [ { "code": "{\n \"number\": \"+19142661483\",\n \"status\": \"received\"\n}", "language": "json" } ] } [/block]