{"_id":"59244fee1e32eb190028ad90","parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","version":{"_id":"542ecc0a6b0eb6080066ca77","forked_from":"542dbe0fcb19820800c1f4da","project":"542dbe0ecb19820800c1f4d7","__v":31,"createdAt":"2014-10-03T16:17:14.165Z","releaseDate":"2014-10-03T16:17:14.165Z","categories":["542ecc0a6b0eb6080066ca78","542ef44f6b0eb6080066cb24","543bf3e22a30961a00b66eb3","5446952b82bd7e08002768a0","544821ae8d7af31a00dd41ce","544a7885f1aefa08006efc69","544c758e11845f0e001ed8de","544e5565b80812080035be55","544e558dbd51b9080037f8ca","5450b045a66f020800dba73d","5450eb6aa66f020800dba945","5450f39ea66f020800dba989","5450f877a66f020800dba9cf","54510356a66f020800dbaa17","5451274514af501a00b50c99","54513345a66f020800dbab24","54513cc014af501a00b50d24","54515eec14af501a00b50db9","54519b1d14af501a00b50ea9","54519b2aa66f020800dbacb4","54524f9704160008005b1d27","54538d2308d1800800473d95","54538d420c09721000a06a03","54538e5608d1800800473d9a","5453ea9547c30114004fb375","5453eb12b077c31c00067bcb","5453eb27b077c31c00067bcd","5453ed5db077c31c00067bde","548075cbe291c51a00e7e096","5922fa475c48c70f00f21453","59244fd41e32eb190028ad8d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":0,"category":{"_id":"59244fd41e32eb190028ad8d","__v":0,"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-23T15:05:56.953Z","from_sync":false,"order":10,"slug":"sip-registration","title":"SIP Registration"},"user":"542dbdddcb19820800c1f4d6","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-23T15:06:22.297Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"With SIP Registration you can connect your SIP-enabled devices or soft phones directly to Zang Cloud and use our API to build call-handling logic. To send and receive calls using SIP Registration, the following setup steps will be required:\n[block:api-header]\n{\n  \"title\": \"Create SIP Domain\"\n}\n[/block]\nCreating a SIP Domain specifies the domain that you want to register with:\n\n`{domain}.sip.zang.io`\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/88c9219-SipDomain.png\",\n        \"SipDomain.png\",\n        2374,\n        1354,\n        \"#757575\"\n      ],\n      \"sizing\": \"smart\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Create Credential List\"\n}\n[/block]\nCredential Lists are sets of credentials used as authentication when attempting to reach your SIP Domain. Zang will send REGISTER request which will need to be authenticated with a credential from your Credential Lists. You can give each credential any name you want. The password must be at least 8 characters long. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9891264-CreateCredential.png\",\n        \"CreateCredential.png\",\n        2056,\n        1168,\n        \"#f0f0f0\"\n      ]\n    }\n  ]\n}\n[/block]\nAfter a Credential List, you then need to grant your SIP access to your credential. You can grant one or more SIP Domains access to the same credential. \n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1d7449c-GrantAccess.png\",\n        \"GrantAccess.png\",\n        1998,\n        1090,\n        \"#f4f4f4\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Making calls with your SIP Domain\"\n}\n[/block]\nTo make outgoing SIP calls from your registered SIP Domain, you must send the INVITE to your SIP domain:\n\n`{domain}.sip.zang.io`\n\nOutgoing calls by your SIP Domain will be treated just like any incoming SIP call received on a Zang domain. After being authenticated, it will execute the Voice URL configured in your SIP domain. For convenience, we have auto-populated the Voice URL with our default voice InboundXML.  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c1b35f4-VoiceURL.png\",\n        \"VoiceURL.png\",\n        2024,\n        1414,\n        \"#eeeeee\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Receiving calls on your SIP Domain\"\n}\n[/block]\nIn order for your SIP Domain to receive calls from Zang, you will use the same InboundXML or REST API calls you use today. Here’s a simple example how to receive a call to your Zang enabled SIP device. Simply buy a Zang phone number, create an InboundXML script that will ring your SIP Domain, and point the InboundXML script to your newly purchased Zang phone number. Note: yourusername MUST match one of the usernames specified in your Credential Lists.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<Response>\\n  <Dial>\\n\\t\\t<Sip>yourusername:::at:::yoursipdomain.sip.zang.io</Sip>\\n  </Dial>\\n</Response>\\n\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Need Help?\",\n  \"body\": \"If you run into any issues, feel free to contact our support team: [email protected]\"\n}\n[/block]","excerpt":"","slug":"test","type":"basic","title":"Getting Started"}
With SIP Registration you can connect your SIP-enabled devices or soft phones directly to Zang Cloud and use our API to build call-handling logic. To send and receive calls using SIP Registration, the following setup steps will be required: [block:api-header] { "title": "Create SIP Domain" } [/block] Creating a SIP Domain specifies the domain that you want to register with: `{domain}.sip.zang.io` [block:image] { "images": [ { "image": [ "https://files.readme.io/88c9219-SipDomain.png", "SipDomain.png", 2374, 1354, "#757575" ], "sizing": "smart" } ] } [/block] [block:api-header] { "title": "Create Credential List" } [/block] Credential Lists are sets of credentials used as authentication when attempting to reach your SIP Domain. Zang will send REGISTER request which will need to be authenticated with a credential from your Credential Lists. You can give each credential any name you want. The password must be at least 8 characters long. [block:image] { "images": [ { "image": [ "https://files.readme.io/9891264-CreateCredential.png", "CreateCredential.png", 2056, 1168, "#f0f0f0" ] } ] } [/block] After a Credential List, you then need to grant your SIP access to your credential. You can grant one or more SIP Domains access to the same credential. [block:image] { "images": [ { "image": [ "https://files.readme.io/1d7449c-GrantAccess.png", "GrantAccess.png", 1998, 1090, "#f4f4f4" ] } ] } [/block] [block:api-header] { "title": "Making calls with your SIP Domain" } [/block] To make outgoing SIP calls from your registered SIP Domain, you must send the INVITE to your SIP domain: `{domain}.sip.zang.io` Outgoing calls by your SIP Domain will be treated just like any incoming SIP call received on a Zang domain. After being authenticated, it will execute the Voice URL configured in your SIP domain. For convenience, we have auto-populated the Voice URL with our default voice InboundXML. [block:image] { "images": [ { "image": [ "https://files.readme.io/c1b35f4-VoiceURL.png", "VoiceURL.png", 2024, 1414, "#eeeeee" ] } ] } [/block] [block:api-header] { "title": "Receiving calls on your SIP Domain" } [/block] In order for your SIP Domain to receive calls from Zang, you will use the same InboundXML or REST API calls you use today. Here’s a simple example how to receive a call to your Zang enabled SIP device. Simply buy a Zang phone number, create an InboundXML script that will ring your SIP Domain, and point the InboundXML script to your newly purchased Zang phone number. Note: yourusername MUST match one of the usernames specified in your Credential Lists. [block:code] { "codes": [ { "code": "<Response>\n <Dial>\n\t\t<Sip>[email protected]</Sip>\n </Dial>\n</Response>\n", "language": "xml" } ] } [/block] [block:callout] { "type": "info", "title": "Need Help?", "body": "If you run into any issues, feel free to contact our support team: [email protected]" } [/block]