Differences

This shows you the differences between two versions of the page.

--- sa50-00 [2026/09/30 11:14] – [Requirements] Justin Willey
+++ sa50-00 [2026/10/15 15:23] (current) – Catherine Riddell
@@ Line 1: / Line 1: @@
 ====== Two-Way SMS text with SMSWorks ======
+Use these instructions for one way too
 ===== Requirements =====
   * An account with SMSWorks
   * Incoming numbers configured at SMSWorks
@@ Line 12: / Line 12: @@
 ===== Setting Up =====
-  * Generate API key, secret & token in SMSWorks account website
+  * {{:apikey.png?linkonly|Generate API key, secret & token in SMSWorks account website}}
-  * Choose a UserName (normally SMSWorks) and Password that will be used by SMSWorks to call a WebHook provided by IQXHub that will receive and process incoming text messages from SMSWorks. (NB these are not a user name and password from the SMSWorks account - they are ones we set so that SMSWorks can authenticate with us).
+  * Create an **IQX Consultant** called **<color #ed1c24>SMSWORKS</color>** - Create a **Web Login** for this Consultant - Make username = **<color #ed1c24>SMSWORKS</color>** and password = **<color #ed1c24>SMSWORKS</color>**. This will be used by SMSWorks to call a WebHook provided by IQXHub that will receive and process incoming text messages from SMSWorks.
   * Populate the SMSWorksConfig table with the Token (from SMSWorks) and the UserName, Password chosen above. <code>INSERT INTO SMSWorksConfig ( SMSWorksConfigID,Token,ResponseURL,DivisionID,UName,PWord ) VALUES ( '1', '<Token>', 'https://pizza.iqxanywhere.net/job/IncomingSMS',  null , 'SMSWorks', '<password>' );
 </code>
-  * Configure the functions OutgoingSMSCETypes & CustomSMSHTTPRequest
+  * Configure the functions [[technical:outgoingsmscetypes|OutgoingSMSCETypes]] & [[technical:customsmshttprequest|CustomSMSHTTPRequest]]
-  * Upload the IncomingSMS.xml job to Maintenance | Databases Setup | System Jobs and Reports
+  * Upload the IncomingSMS.xml job to the Jobs Folder
-  * Use the Create Hub For Web Services button in Maintenance | IQXWeb Setup | Profiles to create a User (normally SMSWorks as above) and User Class for a user matching the details (including password) set up in SMSWorksConfig above.
+  * In iqxWEB Setup use the "**Create Hub for Web Services**" button at the top and call it "<color #ed1c24>**SMSWORKS**</color>" with the password "**<color #ed1c24>SMSWORKS</color>**"
-  * In Maintenance | IQXWeb Setup | User Classes  Add IncomingSMS to the permitted jobs for the new user class
+  * In Maintenance | IQXWeb Setup | User Classes  Add **IncomingSMS** to the permitted jobs for the **SMSWORKS** User Class
-  * In the SMSWorks Account | Reply Numbers - set the response URL eg: https://pizza.iqxanywhere.net/job/IncomingSMS, and the Username and Password as set up in IQX Web Setup for each response number (NB in the case of non-Anywhere installations - a separate Hub will need to be configure to handle the incoming traffic)
+  * In the SMSWorks Account | Reply Numbers - set the response URL eg: https://pizza.iqxanywhere.net/job/IncomingSMS, and the Username and Password as set up in IQX Web Setup for each response number (**SMSWORKS** for **Username** and **Password**)
-  * In IQX Maintenance | Agency Setup - ensure that Contact Event Types are set up for SM / text messaging - you probably want incoming and outgoing.
   * Check that the Applicant and other phone types for mobile numbers include the **S** Capability.
   * In IQX Maintenance | General Settings set or check the following settings:\\   30 - //Can send SMS Messages via E-Mail// set to N\\   40 - //Can send SMS Messages via HTTP// set to Y\\   90 - //The HTTP Request to use for SMS Messages// should be blank as the function will be used\\ 120 - //Default Contact Event Type Code for Sending SMS// set to the correct code\\   450 - //Contact Event Class for Incoming SMS// set to the contact event type for incoming SMS\\
-  * Against the IQX User record for users who are going to be using Two-Way SMS, set one of the available incoming mobile numbers on the SMS Number view. (This must be done manually using numbers set up on the SMSWorks account web site , the buttons GetNewNumber and Release Number do not currently work).
+  * Against the IQX User record for users who are going to be using Two-Way SMS, set one of the available incoming mobile numbers on the SMS Number view.
+<note important>If non-anywhere Client, a separate Hub will need to be configure to handle the incoming traffic and the URL (which is currently the pizzaURL) will look something like this \\ http://HUB-PUBLIC-IP:HUB-PORT/IQXjob/IncomingSMS \\ eg. http://195.20.254.57:54010/IQXjob/IncomingSMS \\ IP addresses will need whitelisted for this port to be open to, it is normally 3 ip addresses and can be obtained from SMSWorks and passed onto the Clients IT to whitelist. </note>
 ===== Using =====
 Once the system is configured, a mobile phone style icon appears on Applicant / Candidate form next to the Make Contact Event icon. This shows the chat history between the current user and the Applicant / Candidate. All SMS texts (in both directions and from all consultants) also appear in the Contact Event view as normal.
+===== Troubleshooting =====
+<color #ed1c24>**If you get the error "Payment Required"** </color> They may have run out of credit; get the account holder to top up credits on the account \\
+<color #ed1c24>**"Payment Required" and plenty of credits?** </color> Re-do the API Key and Secret in the SMSWorks account and make sure to update the CustomSMSHTTPRequest \\
+<color #ed1c24>**Still trying to send via email when SMSWorks is HTTP** </color> Ensure General Setting **Can send SMS Messages via E-Mail** = **N** AND **Can send SMS Messages via HTTP** = **Y**\\
+<color #ed1c24>**Bad Request Error** </color> Check if its a dodgy number?\\
+<color #ed1c24>**Number not sending through IQX?** </color> Try sending an SMS through SMSWorks Account and if it works, then try again in IQX\\