API Notera HTTPS POST msg UTF-8. API_key JSON Mobilnummer format 1. Skicka ett SMS till specifikt nummer POST parametrar: from msg API_key Exempel:

Transkript

1 API Jojka är utrustat med ett kraftfullt API. Utöka din applikation till att även kommunicera med Jojka. Det är väldigt enkelt att komma igång. Här nedan följer en presentation av alla funktioner. Notera * Alla våra API anrop måste skickas med HTTPS, ej HTTP. * All våra API anrop måste skickas som POST. Använd inte GET! * Parametern msg måste vara i tecken formatet UTF-8. * Parametern API_key måste skickas i alla anrop, detta används för att verifiera dig som kund. Som kund får man sitt unika API_key efter man beställt API-access som tjänst, kontakta oss ang detta. * Alla svar fås i JSON format. * Mobilnummer kan anges i följande 3 format: , , Skicka ett SMS till specifikt nummer url: from=<din beställda alias, tex företagsnamn> EJ obligatorisk parameter. (OBS för Pro och Enterprise har tillgång valfria alias, behöver ej vara det förbeställda alias) Om inte denna parameter skickas med i anropet, kommer utskicket att gå från ditt Jojka-nummer som avsändare. Om denna parameter skickas med kommer du förbeställda alias användas som avsändare, oavsett vad som står i denna parameter. to=<ett mobilnummer> msg=<meddelandet som skall skickas i SMS:et>

2 3 ["message_id":"xxx"] 2. Skicka Ny Kampanj till specifika nummer (inkl schemaläggning) url: from=<din beställda alias, tex företagsnamn> EJ obligatorisk parameter. (OBS för Pro och Enterprise har tillgång valfria alias, behöver ej vara det förbeställda alias) Om inte denna parameter skickas med i anropet, kommer utskicket att gå från ditt Jojka-nummer som avsändare. Om denna parameter skickas med kommer du förbeställda alias användas som avsändare, oavsett vad som står i denna parameter. to_msisdn=<ett eller flera mobilnummer, åtskiljda med semikolon> msg=<meddelandet som skall skickas i SMS:et> scheduled=<tid då kampanjen ska påbörjas skickas> EJ obligatorisk parameter Måste anges i formatet :34:45 name=<kampanjnamn, syns inte för mottagare> EJ obligatorisk parameter Om denna parameter inte skickas med i anropet kommer kampanjen döpas till (Namnlös) &msg=hej&name=Test&API_key=123 ["campaign_id":"xxx"]

3 3. Skicka Ny Kampanj till förvald grupp (inkl schemaläggning) url: from=<din beställda alias, tex företagsnamn> EJ obligatorisk parameter. Om inte denna parameter skickas med i anropet, kommer utskicket att gå från ditt Jojka-nummer som avsändare. Om denna parameter skickas med kommer du förbeställda alias användas som avsändare, oavsett vad som står i denna parameter. to_group=<ett eller flera gruppnamn åtskiljda med semikolon> Ange gruppen all för att skicka utskicket till alla dina kontakter msg=<meddelandet som skall skickas i SMS:et> scheduled=<tid då kampanjen ska påbörjas skickas> EJ obligatorisk parameter Måste anges i formatet :34:45 name=<kampanjnamn, syns inte för mottagare> EJ obligatorisk parameter Om denna parameter inte skickas med i anropet kommer kampanjen döpas till (Namnlös) Test&API_key=123 ["campaign_id":"xxx"] 4. Lägga till ny kontakt (inkl till förvald grupp)

4 url: msisdn=<den nya kontaktens mobilnummer> name=<för och efternamn på den nya kontakten> group=<en eller flera grupper den nya kontakten skall vara med i, åtskiljda av semikolon> Ej obligatorisk parameter Om ett gruppnamn anges som inte finns på ditt Jojka konto, så skapas ett ny grupp med det angivna namnet. upp1&api_key=123 ["msisdn":"xxx"] 5. Lägga till existerande kontakt till förvald gruppurl: POST parametrar:msisdn=<den existerande kontaktens mobilnummer> group=<namn på gruppen som den existerande kontakten skall vara med i> Om ett gruppnamn anges som inte finns på ditt Jojka konto, så skapas ett ny grupp med det angivna namnet. API_key=<ditt unika API nyckel> &API_key=123 ["msisdn":"xxx", "group": "yyy"]

5 6. Ta bort kontakt från förvald gruppurl: POST parametrar:msisdn=<den existerande kontaktens mobilnummer> group=<namn på gruppen som den existerande kontakten skall tas bort från> API_key=<ditt unika API nyckel> p1&api_key=123 ["msisdn":"xxx", "group": "yyy"] 7. Hämta alla meddelande id för given kampanjurl: POST parametrar:campaign_id=<unika id et för tidigare skickad kampanj> API_key=<ditt unika API nyckel> ey=123 ["x", "y", "z"] 8. Hämta leveransstatus för given meddelande idurl: msg_id=<unika id et för tidigare skickat meddelande>

6 ["STATUS"] 9. Hämta SMS svar url: from_msisdn=<filtrera svar på enskilt mobilnummer> Ej obligatorisk parameter Om detta fält inte skickas med så får man alla svar, oavsett vilket mobilnummer som skickat svaret. since_time=<nya SMS svar sedan följande dataum> Ej obligatorisk parameter Om detta fält inte skickas med så hämtas alla svar sedan de senaste 4 dagarna. 12&from_msisdn= &API_key=123 [{ inserted : :54:42, sender : xxxx, message : Stop },{ inserted : :30:28, sender : xxxx, message : Test :) }] 10. Hämta message_id, mottagare och status med campaign_id url: campaign_id=<kampanj id som man har fått när man har skickat iväg en kampanj>

7 23 [{ receiver : xxxxx, message_id : , status : DELIVERED }, { receiver : xxxxxx, message_id : , status : ERROR }, { receiver : xxxxxx, message_id : , status : SENDING_OK }] 11. Importera en hel kontakt lista (inkl till förvald grupper) url: contacts_list =<Posta in kontakt listan> contacts_list_url =<Url för en fil/ström> Man kan välja mellan ströma in en kontakt lista via en url länk med https/http/ftp eller posta in hela listan listan formant måste vara i UTF8. Format på listan kan vara mixat och fungera 100% med CSV format Textavgränsare : finns ingen tecken för det. Fältavgränsare: ett av följande tecken, eller ; Ny post : \n Exempel på mixad kontakt lista namn,telefon\n NAMN;TELEFON;GROUP1\N NAMN;TELEFON,GROUP1;GROUP2\N Svars : { SUCCESSES : DONE } { ERROR :[ TYP AV FEL ]} 12. Export kontakt listan med grupper url:

8 max=<max antal kontakter per gång, max värdet är 10000, om detta värde är ej satt så är max 100 per gång> offset =<position i din kontakt lista> Exempel på export av kontakt lista Svars : { EXPORT :[{ MSISDN : 4673XXXXX1, NAME : GUSTAV LUNDBERG, INSERTED : :22:58, GROUPS :[ GRUPP1, GRUPP2 ]},{ MSISDN : 4673XXXXX2, NAME : NICKLAS LARSON, INSERTED : :22:58, GROUPS :[]}]}