Use this method to get group or channel information.

Field Type Required Description
method String Yes "getChat"
app_id String Yes Unique identifier for App.
chat_id String Yes Unique identifier for Chat Group, or Business Channel.
reference String Optional Unique identifier for the request. This reference will be echoed in the response.

Preconditions for API Functionality

The following table outlines the preconditions that must be met for the API to function correctly. Failure to meet these conditions may result in errors or unexpected behavior.

Condition Description
API must have "Manage Chats" permission The API needs "Manage Chats" permission to manage chats within the app.

Response:

chatDetails

✅ On success, the chatDetails method is returned with an echo of the chat object.

Field Type Returned Description
method String Yes "chatDetails"
app_id String Yes Unique identifier for App.
chat Chat Yes Chat Object.
reference String Optional Unique identifier echoed from the request.

Examples:

Requests

{
  "method": "getChat",
  "app_id": "90090700613754551",
  "chat_id": "4522291356145774",
  "reference": "123456789",
}


api.getChat(incomingMsg.getChat().getId());


api.getChat(incomingMsg.chat.id);


napi.get_chat(chat_id="chatId")

Response

{
    "method": "chatDetails",
    "app_id": "90090700613754551",
    "chat": {
        "language_code": "en",
        "image": "\\/9j\\/4AAQSkZJRgABAgAAAQABAAD\\/2wBDACgcHiMeGSgjISMtKygwPGRBPDc3PHtYXUlkkYCZlo+AjIqgtObDoKrarYqMyP\\/L2u71\\/\\/\\/\\/m8H\\/\\/\\/\\/6\\/+b9\\/\\/j\\/2wBDASstLTw1PHZBQXb4pYyl+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj\\/wAARCAEAAQADASIAAhEBAxEB\\/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL\\/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6\\/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL\\/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6\\/9oADAMBAAIRAxEAPwC3by87asxSZYr6VmxHLDPSpt+1zg4rNM1auXJJ1RwKrTz+ZwBVd5CXyTmmmTmm2JJIcWzTM803dzzRmkUSLI2doPFS27FZ1Hqe9VQ+DT1mxJlhQJmzRVO1mLtjsauVaM2rBRRRTEFFFFABRRRQAUUjHApN4xkmgB1V7mRVibnnFSNKojLE8VjXMqu5IJpMpIbIwPSoyOKbmjdUlBnFNJzQeaSmITBoUc80jtTATmgQ5xg5pAcUp5FJgUAKp5qUtxUWKM0ALnmkJxR1pMUAaCPyKczkNjNQBgDzQz5PFTYu5Ju5pCeaZ0pc4piHZpN1NDUmTQA73oJppPFNyTQBctJCHGP1rYHSufhzuBBxzW2sqIqhnGapEslopodT3FOzTJCikLADk0gkU9GFADqKjFxEc\\/MOKikvY0JHU0BYncjp61SvDsT71Nl1BSRtBqrczmVsmkUh7SloNuapuO1LvxTGYmkMTp3opp60vSgQv40w0d6BigBDyKRcA0\\/OBTcjNACscjikxSHpxSAnNMB\\/UUAU0ZzxTjxSAaTRmgrSUwLOaTdg9KTNB96QxxbNITTc0vagBwNGeaYDRmgBxNNoBoJoEKGNPBZu5qHNKGNMC2jsP4qlNxJjBY1VRqkBzSGPMrkcsTTd5Hc00tTCeKAJN3HWmZ603dxSE0AOzTXNKOlNAy1Ag2nbmmN0qfIxiomA9aAIhnNSHGKZnFLnNACHrTSKUnmkoAUc03HNOJ9KUDByaAEIIFNAweae3tTACaYDhwaCc0YyKAvNIAxSHinH2ptAEhOelJj1o60Z4oAUECkZiaNw9KTdTAAaWm96TdQA8GkJpM0HFAgpQab3pRQBOhFPJwtQrT2Py0hiZyaCeackeRmjZ83tQABcjNN6nFSY7VG67elAxzcAUg60gy3NOA54oAQqTUbKRU5IAqB25oBjKXik69KOgoELkelIetIxweKUUAIRxSDJp5xjmgAUAB4pm7nApzDNIBhqAJBihiMcUHgUmOMmgYmaaaeMUxhQIU0DpTaUGmA4EGkIpcCmnigQdDRnmkJzQKAHZFHBppBoANAAeKBSsKQUASLUg5qJaeDzQMnVsLSE00HimkmkMfupw+bg1GMmpAtAEqRoBlqa5UfdFNzxTGIpDGMCxqIrg9aezYpmcmmSGaBSGkU80AKRzRilJ4pAScUALjd1pu4DpUpHy1FigA3Zpufmp6rTShzQBLnIpOtCn1px4FAxnel25FITTgaAIutL0oB5pxXNMQ3dTCc0rDFAxQIAaMmlpOKAHAmkyaM0maAFJoFJTgKAHL1qXZmkUAc1ICMUikhoB6U4LQXGKFkFAwPAo+Y0obJp2WHOw4+lADcHFMYVMcntTWjbuDSAg4pp608jBpCKYhh460ijmn5B60EY6UAJjJp6gCmdOtGSKQyRiKYMZpucml6c0xDmIFRF6Vsmm7SaABSSakINNUEGpAwxQCISCTml+Y1JwaMA96AsIAKWgKaXFADWXPaomQ9qs49aGHpQDRWAI60\\/ZmnEHuKcMY4oFYiK46U3vUpU4pmcUwsKBTlAphfihSTQBbjMfAYVcijikHC1Ut0Tgua0FljQAChITYGyhb+Gmmwi7DFK13jhBmoXupSCQAAKYglgSFdycseOT0HrVESFOGmdj6KaJ7h5QACQvr61GvIAVTkdcUDuSGbgYMw+rf8A1qj3F2O6RiOxNLhumDxSMQwAxQFx7OOopre1EYIfy3HPbNTbEXnNSVuQqpJ6VJsNPXnnGKRpAOKQxu0d+aCo20nmcdKUtkcUANA9qcV45pD701nzQA0jn2pcHtTvlxRuFMQhQnvSeXjkmnA570pIC8mgBm0CgDNGQQaQY6UASEHtQBntTPMPQCrKndGMDBoAYUJxipFQAYPWmFihx3pjMSc5oHcm8tW4py2wA7VXaUjoeab5r5zuNFguWmhBGKiFspPJpfOwuSaYkjOemBQAPbAfdNNFu4GSKlZQBw3NTx5CjdzRcViKCHJGa0FtkI55qE7Rg0NOF\\/ip3FylgW8Y6VV1JBHaHbjLEComvSHx2qG5uGmQA\\/dB60XFYqKxCkA8HtSo5TOO4xSHceDk4ptMROZ3br3JPT161Huwcjimg4peScDrQApzuDHPXrV54MNiqIVnkCc5JxitbySrEmTJpMpFJ45BnjioV4PzVpN0waYbdZFPzYNIbKRAbpTnAVRg0r2kkQO1gRUBWYdadhXH5Jpu3JpoMmeRxUqFVbJFFguNdTtpyoGTPTFMlk3NgdKQydADgUguKRtpG5FAKn3pyuMdMmgYoxtphxu460oPXNIF+bNAF8wojbhz61JGUPOOlV1fKkk1D5rHKrQMmndWYkdqg7ZJqNt2cNxR1HWgkHYDpQvPOKQISc9akSNzxkCmAhcKc9alUs6\\/KMVIsEUQ3Oc1BLPvOEGAKQxcrEfnbJqT7agAwKqqhc5JpWUFgFHSgVycySTn5eBTfKcn5m4qVIW2Db8vvStbBVyzk0DIyka9TmgDzAQoIX6U7ci\\/cGalWbaMbck9gKAKbo4XH5j196hPAHvV++SQQrIwCEHgd6qybecruH94cGncloi5607aSARz6+1KXiwMRvx6t\\/8AWpCzEYA2g9hTET24wRIx4Xhc0r3R38GlubaaOMbQWUD+GqHOaW5V7F4XJP3jTgVMq5biqShm4AqxFazMwzwKLBc0Sq8cnFMdFA45qykW2MZ5NRykKvNUQU\\/lzil8pScZoZo9uAOaZvUCkA97M4yCDTDZPjpUiu5HytxS\\/aZANpoGVzbyIPu0wKyt0q4JWfjikJAPPWlcpIrbfRaQrxnvVhmwO1Q880hkRPHWkDFTkGikxTEOZi3JpAKXFP2HGcUCFTGMLxTsFerVFsbsKUK5PQ0DuDFm+lMCVKWI420Bmx9zigQRBA3z9KmaRYyCE4qDJPIHNLM0hQbqB3HSXJbgcCk3kx53fhVbLHtSoGBztNFguTwg55HWtaJEhTOBvxyayf3mAVGKveaXQHv3qWVGzLKhZDlwGA6A06TGPaq8D\\/KR6Gph8w5pIp7lSe3BBeMYI6iqIXLgn1rYC7TWfdQ+VMCPuscj2piNCPpzTJrGKc7iNreopyOMVMrZ5oTBogis44fvGpd8S9SKm4YYIyPeq0tkjZKfKfTtVXM2iO4u16IapSyk8k5p8sPlHDA1WbrTEDEnoKRY3c4xS78Cnxs4YEUASLDJGORxS4LDAq0hZ0w9RThYhuBqWykiLy2RSQcmodzZ5FSbjjIbrTlQsc0iiFzuWmYIHWrjxhV5FReXu5xxTEVgCetSKqgc09YGfk8Cp0g29aoi5V2ZPANWEQ4xVgRjtTgoFAiFYeKBGc9asYGKCBTAiWNc8ipQiYxgUhHHFMDEH1oAk8lMdBQ0CsORTQXNTKOOTQBALVM5xUn2dMdBUmewpaAI\\/KUdqTyc8BasKoPankADikykintEUgHY9amUDFRXIYDcOcc0qOWQMveoNbaEhAFRXEImiKMPofQ1OvI560FPWgRmxuwYRuMNnFXl4AqKeMK6vjvUqEEZ7Uhki806mg04VRIxwHUq4BFY91CYZcA5U8itoiqd9FvhJHVeaBNXM6OEydKuRWpEXz8EVTikMbZFXVvdybcc1RBXa62ErnpVaaVpO\\/FTSwliWx1qELg8ilYq4kDneAelXfMCDrVMx55FMKueCTRYLluW4BXg5NIs7InPeqRBDUrMx6miwXNkAAcU4AEdaaMDikY+lUQP4XvQGBNMK5FC4HagB5NJz60DmnYFACbsdaMZ5FBFC5xjFABnHWnjJprADk04H5eKAHghetSL8xqsiuWyasKcUALISgB9aZ5tOf8AeIQTVRtynnoO9QzSLRaySORxURKxfd4X09KaJDiopZMoc1LNEi4jZFSCs+wuPNTafvL+tX1PFUQKVDDBHFM8raPl6elSZxTS1ADM468U8GgNRkUgAmo25FOJqNjQBk3MXlTEfwnkVGp+bg1oXcfmR9ORzWWevFUmS0WfPKjB5qOSRm5xioiTSh\\/WmIVc5qUjNNVtwxinYwOtAClEC9eahZMjAp+R3pjUgNRiuaaX9KUoWo244NUQAYkdKUZpcelOCNQAwcVICCKNuOtH0oGLignAprMelNyc0AK539achApvWnADvQA\\/JoDZpOo4oQjvQA7g9KUKrDDcik4zxQ5AWkyo7jJIR1Q49qqSRucqeB61a38U0OCeRWZqU47d4JVdWyAeR7VrK3AquWUr0ojYlBTuKxZLUwmmZNOoABmnZpAKMUAITTDTjTTQA01mTxbJDgcVpGoZlyM+lCBozDwaSrbxow4HNQmAirMyNWxTxIAKY0bDqKbigB+5TQWyKZwKXg8CkBrk4HFR7j1NOYgdKaASc4qiCROamXPrUKBvpUgzjrQMftBPWlChTTN4FMMhzQBIy5NN20zfS7jQA4LQRzSAnODSgUAOzgUgwRSDnrTxwcUACr70\\/aDwelKQMVGWxmkxoY8H91vzqu6uhyw49RUxl5600yDjNZmxD5ox94VPZsHjYg9GxTGWNuq061AXeo6Zpgy0FBpdtIDing5pkjcUU4000gEIppFPppoGRkUxlyKmNNxSGZzgo+2gnFWLqLOHHaqbNnirTMmrMeWUimsF9Kj6daM5piGttqMkVK6DqOaixzQBrCPB5qQEAU3PvSjbj3pkhupdxxQduKQ+1AwHJpSnNIDg1IDkUARFMUoqQKW70gUg80AIAc9KeF96QnJo5oAezADA60i81GTSgk9KAJW9c0zcCeBTDuJpwBFADWiQ84x9KoTTtFOyAAgVpMeKyrof6S1Sy02O+2fL9zDUtlcN9pO7owxVfFEXEyn0NIq7NsGlDVAr8D0p4akMmDUE1GGpd1Ah9BpganZoGNNApcUYpDEZQRisq5jMcuD0PQ1rVHPCsqYPXsaaYmrmRnPFLjFOkRomKsKj3c1ZkAfa\\/PSiRQWyOlIzbqMkrx2oA2Rb09YQO1TH60gNMRC6DHpULfLwKsuCagcYPSgBgz2qRD60gAJxUoVQPegBAM801uKlUcUFRigCHPpRuIpdoWmnFAC7vak3YHFIPag8UAPDNjNIzGmZJ6U8DIoAbnPWqV2CJ\\/qKvkYNQ3UPmRhl+8tJjTM\\/saWAAzrn1ppNWbKE7vMPTtUlss425Xt2o3EU+QDqKjPH0oY1qPV808GoM04MaQybPNPBqFTUgNAx4paaDThSAMUUtFAEFzAJkx0YdDWPIjIxDdRW8aqXlt5q7l+8P1qkyWrmTT422k5701lKnBoAzVGZ\\/9k=",
        "description": "Test NEW gROUP",
        "photo": {
            "thumbnail": {
                "width": 120,
                "id": "V_vT9kSn_nullde6c172db6a9b5d9764ea99a1371ed5495d1dda12ffaa56b4b3b55428980b446.jpg.thumb.jpg",
                "height": 120
            },
            "width": 256,
            "id": "V_vT9kSn_nullde6c172db6a9b5d9764ea99a1371ed5495d1dda12ffaa56b4b3b55428980b446.jpg",
            "height": 256
        },
        "tagsDefinition": null,
        "id": "90090684438172188",
        "title": "Group Name",
        "type": "Group",
        "member_count": 2,
        "invite_link": "https:\\/\\/djoin.ndbx.me\\/join?id=oI8TSxmwrNoZlWQz4%2BdfdME01yf%2FXq1D4hGcb%2Fo8x2k%3D&type=Group&pay=0&vappId=0",
        "category": "S",
        "version": "vT9kSn",

    },
   "reference": "123456789",

}