teleconsulting

3. Init

Initialises a teleconsultation booking for the service selected. Beckn init action; the reply arrives at on_init.

POST/teleconsulting/init

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

contextobjectRequired

context.domainstringRequired

context.countrystringRequired

context.citystringRequired

context.actionstringRequired

context.core_versionstringRequired

context.consumer_idstringRequired

context.consumer_uristringRequired

context.provider_idstringRequired

context.message_idstringRequired

context.timestampstringRequired

context.provider_uristringRequired

context.transaction_idstringRequired

messageobjectRequired

message.orderobjectRequired

message.order.providerobjectRequired

message.order.provider.idstringRequired

message.order.itemobjectRequired

message.order.item.idstringRequired

message.order.item.descriptorobjectRequired

message.order.item.priceobjectRequired

message.order.item.fulfillment_idstringRequired

message.order.fulfillmentobjectRequired

message.order.fulfillment.idstringRequired

message.order.fulfillment.typestringRequired

message.order.fulfillment.agentobjectRequired

message.order.fulfillment.startobjectRequired

message.order.fulfillment.endobjectRequired

message.order.fulfillment.tagsobjectRequired

message.order.billingobjectRequired

message.order.billing.namestringRequired

message.order.billing.addressobjectRequired

message.order.billing.phonestringRequired

message.order.billing.emailstringRequired

message.order.customerobjectRequired

message.order.customer.personobjectRequired

message.order.customer.idstringRequired

Responses

200

Example values, scrubbed.

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

3. Init

curl --request POST \
  --url https://phrsbx.abdm.gov.in/teleconsulting/init \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "context": {
    "domain": "nic2004:85111",
    "country": "IND",
    "city": "std:011",
    "action": "init",
    "core_version": "0.7.1",
    "consumer_id": "aarogyaSetu.eua",
    "consumer_uri": "https://aarogyasetu-sandbox.abdm.gov.in/aarogyasetu/api/v3/app/api/teleconsulting",
    "provider_id": "hspa-nha",
    "message_id": "<TXN_ID>",
    "timestamp": "2024-06-25T05:09:45.791121Z",
    "provider_uri": "https://hspasbx.abdm.gov.in/api/v1",
    "transaction_id": "<TXN_ID>"
  },
  "message": {
    "order": {
      "provider": {
        "id": "1"
      },
      "item": {
        "id": "0",
        "descriptor": {
          "name": "<NAME>",
          "code": "CONSULTATION"
        },
        "price": {
          "currency": "INR",
          "value": "0.0"
        },
        "fulfillment_id": "<TXN_ID>"
      },
      "fulfillment": {
        "id": "<TXN_ID>",
        "type": "Online",
        "agent": {
          "id": "<EMAIL>",
          "name": "<NAME>",
          "image": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCADIAKADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwCU8cZppp559KaV61TERnOaTJ9aeRzSbeaQCDPrQGoC0dPTFIBR1p4NZep61aaVAZJn3N0Cr1NcNqvi++vmZbd2t4SB8qHn8TQkB6VLe29tgyzIgPdmwKjj8U6bbhX/ALQh5OMBwTXjUk8krF2ZmYnJLHJNNDN71XKGp79Z/EPQ48CXUE646GujsfFmg34j8nV7ItIcKjTKrk/7pOf0r5f3HnOaljl29x+dHKhH1uuGGQRz0INPAr5k0jxhrmjBVsdUmjjAwImO9APZWyB+Fet+E/ihY6uiW+rCOyvC2AwyIpPoT909sE+mCeglxYHoGMUpFJFLHOqvE6ujAEMpyCCMg/SpdlSBFtpcVLso2UAQFeKaARU5U56UmznmgDzDGO/NNxTzz60jHjn+daDImB9aaR61IR7UxgBUjEP41mavq9vpVsZJmO48Io6san1S/XTdOlumAIReBnqew/OvJtU1K51C6e4uJNx6AdgPQUIQ7U9Tk1G6a4nbn+FR0X2rP8704qNmZjnH40EY64NUA8Pk5qQBs5HFRRu2QAo49qmaQbjk8jjFAxC5yQevrUoQYyxH401FIJc4HpSEF2+bnjigLEwMajoc/WrCMNmFPP8AOqcYBwPTuanDbQpzxjGaYrHdeDPHd74buIoJy01iWw0ZOdoPcfzx/LJz7/pt7b6nYxXltIrxSDIZTkV8kxOZCc/UV0Xh7xLe6LdiazmZGH38fxD39fxocbiPp/bRsqroupJq+kW18gG2aMOMH1/r2/CtDFZ2EQlMdKTbU2KNtAHkWfwpCR/+umBuOv40m/8AKrKHGmM3r+dIX56/rUZk681IzkvHepGOyjsl+/IdzfQf/X/lXnsr5QAfjXV+Oj/xNEwCT5I5/E1yKo0hCjrVdAJItg4PX27VOLJpOUT86kgthGMsMmta3ZeBispTa2NYwvuYb2VwpOQce1CQ7DwpZu5PaulCIT0zmporaEvuK81Htmty/Y32Miz0qa55cfKOnatGPw8rZMkgX0x2rU3YwBhR6AVLGgJz+tZyqy6GsaUepgSeGwD+7kO33qtPosqLw2SOldccbearvHuz3pKrMHRicTskt5MNnNTW8jpMGXOf51f1a32yBscZ5qnG+WATHFdkJcyucc42dj6Q+FhY+BbRWBG15AATn+In+ZNdrxXF/CtNvgGybP3nkP8A4+R/Su0pPchCcUuKQ4pRikB4lu59KN3cio9+cn+tN3cVRQ8nI9Pem7qaWGCc0zcKQHG+PIG321wB8uChP6/41y1km4lscCu68ZW/n6GZB1idW+ueP61y3lRWsezOAo5NJvQqK1GYJPAq3bR56iq0V7b5wRx61pWtxaMRiVc+nSsJtnRBLuWooCQOOKnjjZelWbdUdRtYEH0qyYB2Fc0qh1qmuhSETE561MkbCrkVvu4Aq+lgNmSwqXUK9mjH8s45pGTA61ozQomf3ikj0NUGljZ9oYZqoybIkl3MnUo12EuCR6isCNAJTiu0eBZIyrruU9ciqmi+Hk1DxjY6V/yymkBbPBKAbmwfXAbFdtCfQ4q8LanvXgazax8E6RA+N32dZCAMY3fNz7810GajQKiKigBVGAB2FPFWcwopaQUUAeGE8Uh9/wCdO68U0jNUUNbB55pp4oOSe+PemnPUYxSGZ+uN/wASqXG08qDn03DP6Vw9wqyH5zxXe6igewmBGeM/lXGS2/mqyAcmok7FwVzNj+yg4WF5CPQkVetLOHUFP2WOZmVlUhUZsE5wMgdTg/kaZb20trMGUFWHGcZrV0pY9Ovftlv+7nwQGCqQM9cAg4rNyRootlWCZ9OuCsjFSDtIPFdJZ3qTgAMDXKaxm5mZy8kkjdWds8Z6VoaDE6j5ieKxqxTVzelJp2OpkLKgCsVHqK57U5isuDeS5P8AAuTWxL5vlgrWY1rcpeLcqfmBzgqKypNI2qpspWtzayP5ctzIrA42kc5/GtIWVjNjbM4PTJbvTrDTok1Fr5jtZm3tDtJjdvcbgevPWrV5C93ftezNunf7zBQoP4Ct5TXRnPGm+qFt7doFKby6dieorT8NTz2XjSxubeGGR3CwDzR03NgkHscHGeevQ1SjLhNpFa/hyF5vEmlpEhdhco5A/uqck/gMn8KinN8xc4R5bM9s+tKBRilA4rsPNFoopaYjw4rntikxUjDBI5pmPzqiyJ1z15pv4YHpTm46Uc0gKmo/8g+fA/gOa5CIgPk12N9n7BP6bGz+VcUrAGs6mxtSepqoiTrnFO+xrzg5plkw4GOataiZYtJuJ4Qd6L1HUepribd7HoKKtc567K/bDEuDt61uaNbkoTnk1j2FsgtBM3zO3zMTXW6HbCQoqsoB7npV1HaNiKUW5DzG0eQw4p5tt0YK4OfStS401/MKF0PbKsCD+NZtxbS2TDn5SexrjTOxplb7O2cfNViG1Tgux+laGmLHdN5bjk9zVq5s44QQKpyYuVXMiaNQuVFdZ8PLMS65NcsissEGFJ/hZjjI/AMPxrl5htGAciu4+GynOon+HEfbr96unDbnFi9InfUtJTwPau08wSnAZoxihaYHi99AYZTxVJmwK6/VNPEqEgZrkLqEwyEEEGqTKImb16e1N3H1NRs2M03f60AOuB5ttLGDjcpHr2rgXYh29jXe7xXF6nB9n1CRMYUnK/SoktC4PUtWE3OSK2hfpBD8xGDwQa5yzYAgE49KvPGPJPOWx3rjlC8jvjUajoR3N0mx4rZQiN1VVGP/AK1aWiie1si+49ehPSubjlmWYx+WMjuDW3aSXKqEdDsP+e1OcHaw6Tu7nQ+d9qhG6Rwp4JB5FSNLEtv5OWb0LHJrKhuhGuxRgZ6YqR7qR8KsKluxPasXTZu52Jra8a3uR1wK1Jb4zIOcmudhNw0uJ1Qem3Na0fCgDk1MopExqN7jySVNelfDuFV0S4lwdzz7ST3AUY/ma82YrjOOa9m0CxbTNDtLRxiREy4JBwx5IyOuCSPwrow8epx4qWljS705TTO9KDXWcJJkeoxThg/SoyAy4IBB9RThjjFMDjpArDBrn9WtLdlLFlB+tZF94luZiRGdgrFlu5ZSS8hOfWqsCC4CLKQpyM1Fn1phcetRTXMNtHvmlRF/2jjNA7k+T61ieI7XzbQXKcPF156rTbrxJbRIfs4MpHc5Arl9Q1C71BSzsfmYKFHRafL1Yc2uhYtbrJB6VfF2SRg9RzXOKzIqtnINWre9+ba351hKHVHRGobQj8x93Q+tbdvLsjVSCe3ArHtZQ6HB6VrQSbkGBtFc8nY66ba2L1vKqlgU5PGStSMygZA5PWooAHTqM05kCjLEVm3c0bfUdwx57U9Zdg5P0qjJeIG2LzUaXBnbaoO0dWzT5LmTqWO+8C6K+p6kNSuF/wBEtG+TnG+XqPwHB+uOvNepbq8j8M/EW30zT00+6tv3Vt+7WSEAHGT94Z65ySRycgkZNeg6P4n0nXEQ2N9DI7gkR7sPgdflPP6V2xhaOh59STlLU3Vb3p4NVw3pT1aqIJwaXdUQPIp+aAPnKe+t4CRLOinuuefyrOn8QWseREryt2/hH+P6VzZBNMK47Ct+QnmNWbxBdykhFSJe23k1mSTGaUySMXc9WPNMCEg9BSqCT1qkkhXGsgZGcnlT079KbaKrAZGQsyHHtmnSKuGU5yeQR2plrgyPGQCHXHtmpmrocXqQFP3YHbJFM+zMTgVoi1L2ZfB4kbt71JBEGwCK43Ox1qNyta3EtqcHOPRq149Sk8vaqJk991KlkSp24Yehp8enJn5o2X3FZucXuaKMlsOhvriMjgYz605r26uGEak49FGau29jAAAU3n3FaMUGB8qBR+VZupFbI0UJPdmVBp8r/NM20H+Edfxq95YjQKgAA7Crfl4FU7tySLeJsSuM5/uL3b/D1P41CqOTLcFFGMsrGF14wbidv0jH9KppKUldM8Vcl2h2RPlSKIAf8C5H/joWqKFRNuODxivUoO8LnmVfisdZZfEDxLYRJHHqUrxo2dsqrJuHoWYFsewI9q9C8LfFKz1NltdZRLO4J+WZM+U3PQ5yV7ckkcEkjpXiik45PNKpK4II49a0cEzO59Xg465qQHivnnQ/H+uaOkUEV15ltHwIZgHXGMAZ+8AOMAEDivRtI+KmmXbBb61mtCWI3qfNQDHU4AP4AGsnTaHc8A6ngUhDE+tBPHU/lTycjuc81uSM9qao+bPank89PzoUH+FRTAY2chux4P8A9eq7Axy8ZHOau9QwIGDwaiZN2QwwQMj3FJoDb06ZL228kqAwByAMULYMH6YrDt5ntpdyHBHH+f8AP9a63T9Qgu1CyMqSD14rgxFKS96J20KifuyFtYCvDCr6WwbkLUpg2dafH8tedKTO9JDFgYdjUoiNTqfeqVzcySStBagM68PI33I/r6n2/lSV2xtpFa/vPs7i3hXzbpx8qDsPVvQVl3MgsIjE7Ga5nOZcdWHp7DsPrVieW105pPKJnu5PvtnJJ9+w+grILMsrSyNvmfrjt9K7KFBz9DkrVeX1GyuYomV2BldjJIQOCx5qtEAFLEfMeBnt/nmkLGWTDYxnk+v+f8+pftJAweP4Qf516iSSsjzm76sAvHuaXBAFLgjjOfwpDnJwaoQDIP8A9bpU6SOhyCfwqvtJOeKepJzgnH6UAU93cc0gcnj+tNJXPfNOJx+FAAWPTI6UFj1x+VJkY+7n6U0MOfl5oAmDEEds0pIcbehHIb0qNW78gU4jcvGOOlADNuTzwR/n/P8A9enxs0bAhtpB4IP+f/1GgfOcbsEcZFKEOQuMjvj/AD9PypAb+iTz32p2loVllV5QHSIMzbQctgLk9Aa9K0vwBBrD3EsWpmFFnkjWJ4n3AKxHILg9u9eeeBZIbfxlYyzMVjxOhI7FoXA/U4/GvZTr58M+C11R40aa8kMkanO3fJuk5IHQDcffGMjOa468E5aI6adRqO5HJ8LdN8ooZS4zjLGXPT1WQe35Vjn4faYtxPpys8UKpGUcQTnYXLDPL4wCAefx9ao+Hvilqtz4qjtNTED29zMsIWFdoibdgMDnkZPOSeOQeMHv/Ek6RaBrN8Ig72lq0xAPJKAuMeh44OOKzdOxaqa6nzpJKscC+Vhc9SByeaoMWfOOB6/0/GrbRZRRySqAADj1zz+VV5isXBwW9B0H+RXopWRxuV2Qg/dRQMfzqXLdMg81FGQW3HipGcgbhnng0CHfePX60jHIx3PWhWJB4Ge5zTWYg8DmgBQSF6Z59acp565pnUf/AFqXkAfSgZR3Z745pRu3AEn1qPdgY459aercd+uKQD/mORk+tNUFuuf6Up9D/OhCd2cfgTQA8LT19wOexNNzkcrz6Uu5dvGaYhvIPNSBSeQ1JwRjH04oAKNyDg/hQFzuPhnbpceJpoJ4i6S2kiKw6q2VOfrgNXq154YXxP8AD/TrAzeRJHBFLDIckBgmOQMZBVmHtnOOK8y+Hwg+wa/NI+2SCBGjOOu5ZVI/UV7RoMKv4c048jdaxnr/ALIrlq/Fc1Wx5x4a+F97puvWt5ql9ayx2zLKsdsWYs4OQCWUYAPPv0rtdbVv+Eb8TqUA3204U5ycfZuv510iwxqo24A9a5fxZdJZeGddlfAX5oskAcvAFH15YD1qL3aGj58uJ2CqMljj1rPkJdsValcknJzntmq643HBGScV2mKHIML8uM/nQSCwycD6UrqoI4PvTFBbgH9OaAHkgKc8+4ppIJ4BqXcMDnI75qMHJPOaYARlgduRSkEHBGKAfYkelAIxnbjHSkBnJ8w+Y/nSrx0x6UUUkMfjP3uffNKpGf50UUAPGWH04pD2HGaKKYh6nB6+9SnkEkkg9s80UUDO78DWtufDmvXtzvxsjiUj1zn8sla9r8PGWPQbSG5jEUiRhAo7ADAoorjqfEzRbIuMrB8AmuK+J2oGDwRLbXKIVvpgkbxcjKyK6fiUQ/jRRSgveQ+jPBpctwQT/SmhfmBOPxFFFdpiNfcRnPTgClQHbn27UUUwEycYwRRgryBxRRSAcNxGC3HvSHOMY/H1oopgf//Z",
          "gender": "M",
          "tags": {
            "@abdm/gov.in/experience": "5.0",
            "@abdm/gov.in/languages": "Eng, Hin",
            "@abdm/gov.in/education": "MBBS",
            "@abdm/gov.in/hpr_id": "<ABHA_NUMBER>"
          }
        },
        "start": {
          "time": {
            "timestamp": "2024-06-25T13:00:00"
          }
        },
        "end": {
          "time": {
            "timestamp": "2024-06-25T13:15:00"
          }
        },
        "tags": {
          "@abdm/gov.in/slot_id": "<TXN_ID>"
        }
      },
      "billing": {
        "name": "<NAME>",
        "address": {
          "door": "",
          "name": "<NAME>",
          "locality": "13-6-454/36/1, Hiranagar, Gudimalkapur, Asifnagar, Hyderabad, Andhra Pradesh",
          "city": null,
          "state": "Telangana",
          "country": "INDIA",
          "area_code": "500067"
        },
        "phone": "<MOBILE>",
        "email": "<EMAIL>"
      },
      "customer": {
        "person": {
          "dob": "<DATE_OF_BIRTH>",
          "gender": "M",
          "dayOfBirth": 20,
          "monthOfBirth": 12,
          "yearOfBirth": 2000
        },
        "id": "<REDACTED_ID>@sbx"
      }
    }
  }
}'

{
  "message": {
    "ack": {
      "status": "ACK"
    }
  }
}

Generated from the schema. The values are placeholders, not a captured response.