{"__v":10,"_id":"56ab2fe1f9757e0d007c6568","category":{"__v":3,"_id":"568fd23804440a1700e4cb5b","pages":["569fb6a8b4f2d31900898ced","56ab2dc70b9e0b0d006161c4","56efbfcb20419a0e00113caa"],"project":"568fce2a04440a1700e4cb47","version":"568fce2b04440a1700e4cb4a","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-08T15:14:00.072Z","from_sync":false,"order":7,"slug":"soap-web-services","title":"SOAP API"},"parentDoc":null,"project":"568fce2a04440a1700e4cb47","user":"55116f88e2990b0d00fb0552","version":{"__v":20,"_id":"568fce2b04440a1700e4cb4a","project":"568fce2a04440a1700e4cb47","createdAt":"2016-01-08T14:56:43.101Z","releaseDate":"2016-01-08T14:56:43.101Z","categories":["568fce2b04440a1700e4cb4b","568fd1b8b700ce0d002f4b1c","568fd23804440a1700e4cb5b","568fd2444719c119002ce5d8","568ff21204440a1700e4cbc1","5693732c8aa8040d009f2c28","5693738393445b0d00abdad0","5693740093445b0d00abdad1","56937445974aaa0d001ca699","5693b82173f48f0d0075c90d","5694c4cd1005590d0062cb25","569f854466a5640d00efa54c","56a264cdd15dd70d008d825b","56aa56bf318e6c1700a19ddb","56b0e6347ae4550d000627bd","56b200c0f48f270d00e0de6f","56b200c6f48f270d00e0de70","56b22a9665ddf50d0076ba40","56e92ef71996862200fd7f42","574d6577fb835c0e00ca316a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-29T09:24:49.280Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"The ValidateNumber method allows you to check check the validity of a phone number and whether the handset is currently on or off. You can also discover details about the network the phone number is on and whether the phone is outside its native country.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Performance Tip\",\n  \"body\": \"If you need to validate multiple numbers, consider using [ValidateNumbers](doc:soap-pnv-validatenumbers) to reduce network overhead and get better throughput.\"\n}\n[/block]\n<div class=\"alert alert-success\"><div class=\"label label-success\">SOAP Action</div> &nbsp; **http://<span></span>www.dynmark.com/20111116/1/PhoneNumberValidationService/ValidateNumberRequest**</div>\n\n##Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"<code>Number</code><span class=\\\"c-danger\\\">*</span>\",\n    \"0-1\": \"The phone number to validate. This can be in international or local format.\",\n    \"0-2\": \"The phone number to send to. This should be in international format (e.g. 447123123456), or if countryIsoCode is specified, in local format (e.g. 07123123456)\",\n    \"1-0\": \"<code>IsInternational</code>\",\n    \"1-1\": \"If set to true, the supplied number is in international format.\",\n    \"1-2\": \"A string containing the from value. This can be either: Numeric: between 2-15 characters, permitted characters 0-9 Alphanumeric: between 2-11 characters 0-9, a-z, A-Z, hyphen, underscore, full-stop and space e.g. MAYFLOWER. If no originator is set this will automatically assign a default number so that the recipient may reply to the message. If you have purchased a dedicated number this can be used as the originator\",\n    \"2-2\": \"An optional country in ISO 3166-1 alpha-3 format. If specfied, the to field can contain a number in local format, e.g. GBR would allow 07123123456\",\n    \"2-1\": \"Determines which international dialling code is prepended to the normalised number when normalising local format numbers. This parameter accepts country codes in [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format.\",\n    \"2-0\": \"<code>RequiredCountryCode</code>\",\n    \"3-0\": \"**body**\",\n    \"3-1\": \"string\",\n    \"3-2\": \"The message text\",\n    \"4-0\": \"deliverAfter\",\n    \"5-0\": \"validiUntil\",\n    \"6-0\": \"clientRef\",\n    \"4-1\": \"DateTime\",\n    \"4-2\": \"A date time specifying when we should try to deliver the message.\",\n    \"5-2\": \"A date time specifying how long we should try to deliver the message for.\",\n    \"5-1\": \"DateTime\",\n    \"6-2\": \"An optional string value (with a maximum length of 64 characters) that will be returned with the delivery status to allow you to pass integration information.\",\n    \"6-1\": \"string\",\n    \"7-0\": \"deliveryStatusUrl\",\n    \"8-0\": \"filterSetName\",\n    \"9-0\": \"rejectUnicode\",\n    \"8-2\": \"If you have enabled Intelligent Filtering on your account, in the user portal, you can specify which filter set is applied to this message.\",\n    \"9-2\": \"If set to true, any messages containing Unicode characters will not be sent.\",\n    \"7-2\": \"A callback URL that will have the delivery status for the SMS sent to it. The page located at the URL will need to return a HTTP status code of 200 to indicate it has accepted the data within 10 seconds. See the Receipt handler documentation for more details\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Description\",\n    \"7-1\": \"string\",\n    \"8-1\": \"string\",\n    \"9-1\": \"boolean\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n##Response\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"<code>OriginalNumber</code><span class=\\\"c-danger\\\">*</span>\",\n    \"0-1\": \"The phone number supplied in the request object.\",\n    \"1-0\": \"<code>NumberStatus</code><span class=\\\"c-danger\\\">*</span>\",\n    \"1-1\": \"The status of the phone number. This is one of the [NumberStatus](doc:number-status) values.\",\n    \"2-0\": \"<code>NormalisedNumber</code>\",\n    \"2-1\": \"The normalised number when supplying a localised number, e.g. 07770123456 is normalised to 447770123456.\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"3-0\": \"<code>NetworkDetails</code>\",\n    \"4-0\": \"<code>IMSI</code>\",\n    \"4-1\": \"The [IMSI](https://en.wikipedia.org/wiki/International_mobile_subscriber_identity) associated with the number.\",\n    \"3-1\": \"A [NetworkDetail](#section-networkdetail-object) element describing the network that the number belongs to.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n##NetworkDetail Object\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"<code>NetworkName</code>\",\n    \"1-0\": \"<code>NetworkPrefix</code>\",\n    \"1-1\": \"The network prefix, e.g. 7770\",\n    \"0-1\": \"The network name\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"2-0\": \"<code>CountryName</code>\",\n    \"2-1\": \"The country name.\",\n    \"3-0\": \"<code>CountryCode</code>\",\n    \"3-1\": \"A two digit country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, e.g. GB\",\n    \"4-0\": \"<code>CountryIDD</code>\",\n    \"4-1\": \"The dialling code for the country, e.g. 44\",\n    \"5-0\": \"<code>RoamingNetworkName</code>\",\n    \"6-0\": \"<code>RoamingNetworkPrefix</code>\",\n    \"7-0\": \"<code>RoamingCountryName</code>\",\n    \"8-0\": \"<code>RoamingCountryCode</code>\",\n    \"5-1\": \"If the phone is roaming, the name of the network being used to carry\",\n    \"6-1\": \"If the phone is roaming, the network prefix, e.g. 7770. This will always be the same as the NetworkPrefix.\",\n    \"7-1\": \"If the phone is roaming, the name of the country it was last seen in.\",\n    \"8-1\": \"f the phone is roaming, the country code of the country it was last seen in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\",\n    \"9-0\": \"<code>RoamingCountryIDD</code>\",\n    \"9-1\": \"If the phone is roaming, the dialling code of the country it was last seen in.\",\n    \"10-0\": \"<code>MCCMNC</code>\",\n    \"10-1\": \"The mobile country code and mobile network code.\",\n    \"11-0\": \"<code>IsPorted</code>\",\n    \"11-1\": \"Flag indicating that the number has been ported from one network to another.\",\n    \"12-0\": \"<code>PortedNetwork</code>\",\n    \"12-1\": \"The network the phone was ported from.\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\n##Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var request = new ValidateNumberRequest\\n{\\n   Number = \\\"447979080215\\\",\\n   IsInternational = true\\n};\\n\\nvar client = new PhoneNumberValidationClient();\\nvar response = client.ValidateNumber(request);\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"Validate an international or local phone number","slug":"soap-pnv-validatenumber","type":"fn","title":"ValidateNumber"}

ValidateNumber

Validate an international or local phone number

The ValidateNumber method allows you to check check the validity of a phone number and whether the handset is currently on or off. You can also discover details about the network the phone number is on and whether the phone is outside its native country. [block:callout] { "type": "info", "title": "Performance Tip", "body": "If you need to validate multiple numbers, consider using [ValidateNumbers](doc:soap-pnv-validatenumbers) to reduce network overhead and get better throughput." } [/block] <div class="alert alert-success"><div class="label label-success">SOAP Action</div> &nbsp; **http://<span></span>www.dynmark.com/20111116/1/PhoneNumberValidationService/ValidateNumberRequest**</div> ##Parameters [block:parameters] { "data": { "0-0": "<code>Number</code><span class=\"c-danger\">*</span>", "0-1": "The phone number to validate. This can be in international or local format.", "0-2": "The phone number to send to. This should be in international format (e.g. 447123123456), or if countryIsoCode is specified, in local format (e.g. 07123123456)", "1-0": "<code>IsInternational</code>", "1-1": "If set to true, the supplied number is in international format.", "1-2": "A string containing the from value. This can be either: Numeric: between 2-15 characters, permitted characters 0-9 Alphanumeric: between 2-11 characters 0-9, a-z, A-Z, hyphen, underscore, full-stop and space e.g. MAYFLOWER. If no originator is set this will automatically assign a default number so that the recipient may reply to the message. If you have purchased a dedicated number this can be used as the originator", "2-2": "An optional country in ISO 3166-1 alpha-3 format. If specfied, the to field can contain a number in local format, e.g. GBR would allow 07123123456", "2-1": "Determines which international dialling code is prepended to the normalised number when normalising local format numbers. This parameter accepts country codes in [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format.", "2-0": "<code>RequiredCountryCode</code>", "3-0": "**body**", "3-1": "string", "3-2": "The message text", "4-0": "deliverAfter", "5-0": "validiUntil", "6-0": "clientRef", "4-1": "DateTime", "4-2": "A date time specifying when we should try to deliver the message.", "5-2": "A date time specifying how long we should try to deliver the message for.", "5-1": "DateTime", "6-2": "An optional string value (with a maximum length of 64 characters) that will be returned with the delivery status to allow you to pass integration information.", "6-1": "string", "7-0": "deliveryStatusUrl", "8-0": "filterSetName", "9-0": "rejectUnicode", "8-2": "If you have enabled Intelligent Filtering on your account, in the user portal, you can specify which filter set is applied to this message.", "9-2": "If set to true, any messages containing Unicode characters will not be sent.", "7-2": "A callback URL that will have the delivery status for the SMS sent to it. The page located at the URL will need to return a HTTP status code of 200 to indicate it has accepted the data within 10 seconds. See the Receipt handler documentation for more details", "h-0": "Parameter", "h-1": "Description", "h-2": "Description", "7-1": "string", "8-1": "string", "9-1": "boolean" }, "cols": 2, "rows": 3 } [/block] ##Response [block:parameters] { "data": { "0-0": "<code>OriginalNumber</code><span class=\"c-danger\">*</span>", "0-1": "The phone number supplied in the request object.", "1-0": "<code>NumberStatus</code><span class=\"c-danger\">*</span>", "1-1": "The status of the phone number. This is one of the [NumberStatus](doc:number-status) values.", "2-0": "<code>NormalisedNumber</code>", "2-1": "The normalised number when supplying a localised number, e.g. 07770123456 is normalised to 447770123456.", "h-0": "Property", "h-1": "Description", "3-0": "<code>NetworkDetails</code>", "4-0": "<code>IMSI</code>", "4-1": "The [IMSI](https://en.wikipedia.org/wiki/International_mobile_subscriber_identity) associated with the number.", "3-1": "A [NetworkDetail](#section-networkdetail-object) element describing the network that the number belongs to." }, "cols": 2, "rows": 5 } [/block] ##NetworkDetail Object [block:parameters] { "data": { "0-0": "<code>NetworkName</code>", "1-0": "<code>NetworkPrefix</code>", "1-1": "The network prefix, e.g. 7770", "0-1": "The network name", "h-0": "Property", "h-1": "Description", "2-0": "<code>CountryName</code>", "2-1": "The country name.", "3-0": "<code>CountryCode</code>", "3-1": "A two digit country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, e.g. GB", "4-0": "<code>CountryIDD</code>", "4-1": "The dialling code for the country, e.g. 44", "5-0": "<code>RoamingNetworkName</code>", "6-0": "<code>RoamingNetworkPrefix</code>", "7-0": "<code>RoamingCountryName</code>", "8-0": "<code>RoamingCountryCode</code>", "5-1": "If the phone is roaming, the name of the network being used to carry", "6-1": "If the phone is roaming, the network prefix, e.g. 7770. This will always be the same as the NetworkPrefix.", "7-1": "If the phone is roaming, the name of the country it was last seen in.", "8-1": "f the phone is roaming, the country code of the country it was last seen in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.", "9-0": "<code>RoamingCountryIDD</code>", "9-1": "If the phone is roaming, the dialling code of the country it was last seen in.", "10-0": "<code>MCCMNC</code>", "10-1": "The mobile country code and mobile network code.", "11-0": "<code>IsPorted</code>", "11-1": "Flag indicating that the number has been ported from one network to another.", "12-0": "<code>PortedNetwork</code>", "12-1": "The network the phone was ported from." }, "cols": 2, "rows": 13 } [/block] ##Examples [block:code] { "codes": [ { "code": "var request = new ValidateNumberRequest\n{\n Number = \"447979080215\",\n IsInternational = true\n};\n\nvar client = new PhoneNumberValidationClient();\nvar response = client.ValidateNumber(request);", "language": "csharp" } ] } [/block]